BSD-3-Clause licensed and maintained by Oleg Grenrus

Module documentation for 0.1.3.0

This version can be pinned in stack with:[email protected]:0eaa946a059b74c9fa939bc537d3758f30f0338a21488750782d847d3cd6a604,3801

binary-tagged

Build Status Hackage Stackage LTS 2 Stackage LTS 3 Stackage Nightly

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.

Changes

  • 0.1.3.0 (2015-10-24)
    • Support generics-sop-0.2
  • 0.1.2.0 (2015-10-06)
    • Add tuple HasSemanticVersion instances
    • Add instances for
      • ()
      • Float
      • Double
      • Version`
      • Fixed
      • Ordering
    • Fix Interleave & SumUpTo, introduce Div2
  • 0.1.1.0
    • Add instances
      • Ratio
      • Word
      • HasSemanticVersion for primitive types