binary-tagged

Tagged binary serialisation.

https://github.com/phadej/binary-tagged#readme

Version on this page:	0.1.1.0@rev:1
LTS Haskell 22.18:	0.3.1@rev:4
Stackage Nightly 2024-04-22:	0.3.1@rev:4
Latest on Hackage:	0.3.1@rev:4

See all snapshots binary-tagged appears in

BSD-3-Clause licensed and maintained by Oleg Grenrus

This version can be pinned in stack with:binary-tagged-0.1.1.0@sha256:fd550ffa78871db7e461ba3fba5b85ec3bafe4c75a60f4f70237df6812045926,3779

Module documentation for 0.1.1.0

Data
- Data.Binary
  - Data.Binary.Tagged

Depends on 15 packages(full list with versions):

aeson, array, base, binary, bytestring, containers, generics-sop, hashable, scientific, 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.