Skip to main content

Browse the archive

https://gitlab.com/nomadic-labs/data-encoding/
28 March 2024, 19:55:49 UTC
Revision 0e1dfc4456c35c95ca2ec326d30dd6525adbf13f authored by Pietro on 22 April 2020, 15:38:29 UTC, committed by Pietro on 22 April 2020, 16:10:36 UTC 
Add Version to GADT
1 parent c38bfaf
Raw File
Tip revision: 0e1dfc4456c35c95ca2ec326d30dd6525adbf13f authored by Pietro on 22 April 2020, 15:38:29 UTC
Add Version to GADT
Tip revision: 0e1dfc4
README.md 
Data-encoding
=============

A library for encoding and decoding data. It offers a great degree of control over the layout of data. It supports json and binary serialisation/deserialisation.


Use
---

For a type `t`, you can use the library's combinators to build a encoding `t
encoding`. You can then use the various reading/writing functions with this
encoding to serialise and deserialise values of the type `t`.

Example:

```
type t = (string * int) list
let encoding = list (tup2 string int31)
let v = [("foo", 32); ("bar", 0)]
let j = Json.construct encoding v
let w = Json.destruct j
let () = assert (v = w)
```

Build and Install
-----------------

`data-encoding` can be built from source using `dune`:

```
dune build
```

or installed directly from `opam`:

```
opam install data-encoding
```
back to top