binary-tagged
Tagged binary serialisation.
https://github.com/phadej/binary-tagged#readme
| Version on this page: | 0.1.4.0 |
| LTS Haskell 23.28: | 0.3.1@rev:4 |
| Stackage Nightly 2024-12-09: | 0.3.1@rev:4 |
| Latest on Hackage: | 0.3.1@rev:4 |
This version can be pinned in stack with:
binary-tagged-0.1.4.0@sha256:65ad0b97a568f35720fb0ba252701049fc8e84b9732757a8727a7cabcd9b9640,3965Module documentation for 0.1.4.0
- Data
- Data.Binary
Depends on 17 packages(full list with versions):
aeson, array, base, binary, bytestring, containers, generics-sop, hashable, nats, scientific, semigroups, SHA, tagged, text, time, unordered-containers, vector
binary-tagged
Structurally tag binary serialisation stream.
Say you have:
data Record = Record
{ _recordFields :: HM.HashMap Text (Integer, ByteString)
, _recordEnabled :: Bool
}
deriving (Eq, Show, Generic)
instance Binary Record
instance HasStructuralInfo Record
instance HasSemanticVersion Record
then you can serialise and deserialise Record values with a structure tag by simply
encodeTaggedFile "cachefile" record
decodeTaggedFile "cachefile" :: IO Record
If structure of Record changes in between, deserialisation will fail early.
The overhead is next to non-observable, see a simple benchmark and the results.