| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Data.Binary.VersionTagged
Description
Tag a Binary instance with the stack version number to ensure we're reading a compatible format.
- taggedDecodeOrLoad :: (BinarySchema a, MonadIO m, MonadLogger m) => Path Abs File -> m a -> m a
- taggedEncodeFile :: (BinarySchema a, MonadIO m) => Path Abs File -> a -> m ()
- class Binary t where
- type BinarySchema a = (Binary a, NFData a, HasStructuralInfo a, HasSemanticVersion a)
- class HasStructuralInfo a
- class KnownNat (SemanticVersion a) => HasSemanticVersion a
- decodeFileOrFailDeep :: (BinarySchema a, MonadIO m, MonadThrow n) => Path loc File -> m (n a)
- class NFData a where
- rnf :: a -> ()
Documentation
taggedDecodeOrLoad :: (BinarySchema a, MonadIO m, MonadLogger m) => Path Abs File -> m a -> m a #
Read from the given file. If the read fails, run the given action and write that back to the file. Always starts the file off with the version tag.
taggedEncodeFile :: (BinarySchema a, MonadIO m) => Path Abs File -> a -> m () #
Write to the given file, with a binary-tagged tag.
The Binary class provides put and get, methods to encode and
decode a Haskell value to a lazy ByteString. It mirrors the Read and
Show classes for textual representation of Haskell types, and is
suitable for serialising Haskell values to disk, over the network.
For decoding and generating simple external binary formats (e.g. C
structures), Binary may be used, but in general is not suitable
for complex protocols. Instead use the Put and Get primitives
directly.
Instances of Binary should satisfy the following property:
decode . encode == id
That is, the get and put methods should be the inverse of each
other. A range of instances are provided for basic Haskell types.
Minimal complete definition
Nothing
Instances
type BinarySchema a = (Binary a, NFData a, HasStructuralInfo a, HasSemanticVersion a) #
class HasStructuralInfo a #
Instances
class KnownNat (SemanticVersion a) => HasSemanticVersion a #
Instances
decodeFileOrFailDeep :: (BinarySchema a, MonadIO m, MonadThrow n) => Path loc File -> m (n a) #
Ensure that there are no lurking exceptions deep inside the parsed value... because that happens unfortunately. See https://github.com/commercialhaskell/stack/issues/554
A class of types that can be fully evaluated.
Since: 1.1.0.0
Minimal complete definition
Nothing
Instances
| NFData Bool | |
| NFData Char | |
| NFData Double | |
| NFData Float | |
| NFData Int | |
| NFData Int8 | |
| NFData Int16 | |
| NFData Int32 | |
| NFData Int64 | |
| NFData Integer | |
| NFData Word | |
| NFData Word8 | |
| NFData Word16 | |
| NFData Word32 | |
| NFData Word64 | |
| NFData CallStack | Since: 1.4.2.0 |
| NFData TypeRep | NOTE: Only defined for Since: 1.4.0.0 |
| NFData () | |
| NFData TyCon | NOTE: Only defined for Since: 1.4.0.0 |
| NFData PackageName | |
| NFData PackageIdentifier | |
| NFData ComponentId | |
| NFData UnitId | |
| NFData Any | Since: 1.4.0.0 |
| NFData All | Since: 1.4.0.0 |
| NFData Version | Since: 1.3.0.0 |
| NFData ThreadId | Since: 1.4.0.0 |
| NFData ByteString | |
| NFData ByteString | |
| NFData Number | |
| NFData Natural | Since: 1.4.0.0 |
| NFData Void | Since: 1.4.0.0 |
| NFData Unique | Since: 1.4.0.0 |
| NFData ExitCode | Since: 1.4.2.0 |
| NFData CChar | Since: 1.4.0.0 |
| NFData CSChar | Since: 1.4.0.0 |
| NFData CUChar | Since: 1.4.0.0 |
| NFData CShort | Since: 1.4.0.0 |
| NFData CUShort | Since: 1.4.0.0 |
| NFData CInt | Since: 1.4.0.0 |
| NFData CUInt | Since: 1.4.0.0 |
| NFData CLong | Since: 1.4.0.0 |
| NFData CULong | Since: 1.4.0.0 |
| NFData CLLong | Since: 1.4.0.0 |
| NFData CULLong | Since: 1.4.0.0 |
| NFData CFloat | Since: 1.4.0.0 |
| NFData CDouble | Since: 1.4.0.0 |
| NFData CPtrdiff | Since: 1.4.0.0 |
| NFData CSize | Since: 1.4.0.0 |
| NFData CWchar | Since: 1.4.0.0 |
| NFData CSigAtomic | Since: 1.4.0.0 |
| NFData CClock | Since: 1.4.0.0 |
| NFData CTime | Since: 1.4.0.0 |
| NFData CUSeconds | Since: 1.4.0.0 |
| NFData CSUSeconds | Since: 1.4.0.0 |
| NFData CFile | Since: 1.4.0.0 |
| NFData CFpos | Since: 1.4.0.0 |
| NFData CJmpBuf | Since: 1.4.0.0 |
| NFData CIntPtr | Since: 1.4.0.0 |
| NFData CUIntPtr | Since: 1.4.0.0 |
| NFData CIntMax | Since: 1.4.0.0 |
| NFData CUIntMax | Since: 1.4.0.0 |
| NFData Fingerprint | Since: 1.4.0.0 |
| NFData SrcLoc | Since: 1.4.2.0 |
| NFData ShortByteString | |
| NFData IntSet | |
| NFData URI | |
| NFData URIAuth | |
| NFData Doc | |
| NFData TextDetails | |
| NFData Scientific | |
| NFData UnicodeException | |
| NFData LocalTime | |
| NFData ZonedTime | |
| NFData TimeOfDay | |
| NFData TimeZone | |
| NFData UTCTime | |
| NFData NominalDiffTime | |
| NFData Day | |
| NFData UniversalTime | |
| NFData DiffTime | |
| NFData JSONPathElement | |
| NFData Value | |
| NFData Bytes | |
| NFData Version # | |
| NFData CompilerVersion # | |
| NFData PackageName # | |
| NFData PackageIdentifier # | |
| NFData FlagName # | |
| NFData GitSHA1 # | |
| NFData MiniPackageInfo # | |
| NFData MiniBuildPlan # | |
| NFData ExeName # | |
| NFData GhcPkgId # | |
| NFData PackageDownload # | |
| NFData PackageCacheMap # | |
| NFData PackageCache # | |
| NFData ModTime # | |
| NFData FileCacheInfo # | |
| NFData PrecompiledCache # | |
| NFData ConfigureOpts # | |
| NFData ConfigCache # | |
| NFData InstalledCacheEntry # | |
| NFData EntryContent | |
| NFData Entry | |
| NFData FormatError | |
| NFData TarPath | |
| NFData Ownership | |
| NFData LinkTarget | |
| NFData Root | |
| NFData FilePath | |
| NFData a => NFData [a] | |
| NFData a => NFData (Maybe a) | |
| NFData a => NFData (Ratio a) | |
| NFData (Ptr a) | Since: 1.4.2.0 |
| NFData (FunPtr a) | Since: 1.4.2.0 |
| NFData a => NFData (Last a) | Since: 1.4.2.0 |
| NFData r => NFData (Result r) | |
| NFData a => NFData (Identity a) | Since: 1.4.0.0 |
| NFData a => NFData (Min a) | Since: 1.4.2.0 |
| NFData a => NFData (Max a) | Since: 1.4.2.0 |
| NFData a => NFData (First a) | Since: 1.4.2.0 |
| NFData m => NFData (WrappedMonoid m) | Since: 1.4.2.0 |
| NFData a => NFData (Option a) | Since: 1.4.2.0 |
| NFData a => NFData (NonEmpty a) | Since: 1.4.2.0 |
| NFData (Fixed a) | Since: 1.3.0.0 |
| NFData a => NFData (Complex a) | |
| NFData (StableName a) | Since: 1.4.0.0 |
| NFData a => NFData (ZipList a) | Since: 1.4.0.0 |
| NFData a => NFData (Dual a) | Since: 1.4.0.0 |
| NFData a => NFData (Sum a) | Since: 1.4.0.0 |
| NFData a => NFData (Product a) | Since: 1.4.0.0 |
| NFData a => NFData (First a) | Since: 1.4.0.0 |
| NFData a => NFData (Last a) | Since: 1.4.0.0 |
| NFData (IORef a) | NOTE: Only strict in the reference and not the referenced value. Since: 1.4.2.0 |
| NFData a => NFData (Down a) | Since: 1.4.0.0 |
| NFData (MVar a) | NOTE: Only strict in the reference and not the referenced value. Since: 1.4.2.0 |
| NFData s => NFData (CI s) | |
| NFData a => NFData (Digit a) | |
| NFData a => NFData (Node a) | |
| NFData a => NFData (Elem a) | |
| NFData a => NFData (FingerTree a) | |
| NFData a => NFData (Tree a) | |
| NFData a => NFData (Seq a) | |
| NFData a => NFData (IntMap a) | |
| NFData a => NFData (Set a) | |
| NFData a => NFData (Doc a) | |
| NFData a => NFData (AnnotDetails a) | |
| NFData a => NFData (Array a) | |
| NFData a => NFData (HashSet a) | |
| NFData a => NFData (Vector a) | |
| NFData (Vector a) | |
| NFData (Vector a) | |
| NFData (Vector a) | |
| NFData a => NFData (DList a) | |
| NFData a => NFData (IResult a) | |
| NFData a => NFData (Result a) | |
| NFData (Context a) | |
| NFData (Digest a) | |
| NFData e => NFData (Entries e) | |
| NFData (a -> b) | This instance is for convenience and consistency with Since: 1.3.0.0 |
| (NFData a, NFData b) => NFData (Either a b) | |
| (NFData a, NFData b) => NFData (a, b) | |
| (NFData a, NFData b) => NFData (Array a b) | |
| (NFData i, NFData r) => NFData (IResult i r) | |
| (NFData a, NFData b) => NFData (Arg a b) | Since: 1.4.2.0 |
| NFData (Proxy k a) | Since: 1.4.0.0 |
| NFData (STRef s a) | NOTE: Only strict in the reference and not the referenced value. Since: 1.4.2.0 |
| (NFData k, NFData a) => NFData (Map k a) | |
| (NFData k, NFData v) => NFData (Leaf k v) | |
| (NFData k, NFData v) => NFData (HashMap k v) | |
| NFData (MVector s a) | |
| NFData (MVector s a) | |
| NFData (MVector s a) | |
| NFData (Path b t) | |
| (NFData a, NFData b, NFData c) => NFData (a, b, c) | |
| NFData a => NFData (Const k a b) | Since: 1.4.0.0 |
| NFData b => NFData (Tagged k s b) | |
| (NFData a, NFData b, NFData c, NFData d) => NFData (a, b, c, d) | |
| (NFData a1, NFData a2, NFData a3, NFData a4, NFData a5) => NFData (a1, a2, a3, a4, a5) | |
| (NFData a1, NFData a2, NFData a3, NFData a4, NFData a5, NFData a6) => NFData (a1, a2, a3, a4, a5, a6) | |
| (NFData a1, NFData a2, NFData a3, NFData a4, NFData a5, NFData a6, NFData a7) => NFData (a1, a2, a3, a4, a5, a6, a7) | |
| (NFData a1, NFData a2, NFData a3, NFData a4, NFData a5, NFData a6, NFData a7, NFData a8) => NFData (a1, a2, a3, a4, a5, a6, a7, a8) | |
| (NFData a1, NFData a2, NFData a3, NFData a4, NFData a5, NFData a6, NFData a7, NFData a8, NFData a9) => NFData (a1, a2, a3, a4, a5, a6, a7, a8, a9) | |