1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
# binary-tagged
[](https://travis-ci.org/phadej/binary-tagged)
[](http://hackage.haskell.org/package/binary-tagged)
[](http://stackage.org/lts-2/package/binary-tagged)
[](http://stackage.org/lts-3/package/binary-tagged)
[](http://stackage.org/nightly/package/binary-tagged)
Structurally tag binary serialisation stream.
Say you have:
```hs
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
```hs
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](https://github.com/phadej/binary-tagged/blob/master/bench/Bench.hs) and the [results](https://rawgit.com/phadej/binary-tagged/master/bench.html).
|
