Revision f2144345d531cd8e35dece66137953572ebcba6b authored by Hugo Heuzard on 19 July 2022, 08:55:14 UTC, committed by Hugo Heuzard on 19 July 2022, 08:55:14 UTC
V0.6 release See merge request nomadic-labs/data-encoding!91
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.
Usage
-----
For a type `t`, you can use the library's combinators to build an 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:
```
open Data_encoding
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 encoding j
let () = assert (v = w)
```
Tutorial
--------
A full tutorial is available in markdown form in `src/tutorial.md` and the
generated html is hosted on
<https://nomadic-labs.gitlab.io/data-encoding/data-encoding/Data_encoding/tutorial.html>.
Build and Install
-----------------
`data-encoding` can be built from source using `dune`:
```
dune build
```
or installed directly from `opam`:
```
opam install data-encoding
```
![swh spinner](/static/img/swh-spinner.gif)
Computing file changes ...