package data-encoding
Library of JSON and binary encoding combinators
Install
Dune Dependency
Authors
Maintainers
Sources
data-encoding-v1.0.0.tar.gz
md5=d15b03873f0ccc333b60bfcdf0595766
sha512=0a5355bae421b5d155eeff7ad333cce32cf317b88ac69a07be715ff9a4cd05c8e1715de4917ed8f67789070175654ea3e332a348e586d5005e8772f5672c4a6f
Description
Published: 03 Apr 2023
README
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.
It is available online on ocaml.org's package documentation and on data-encoding's own online documentation.
Build and Install
data-encoding can be built from source using dune:
dune build
or installed directly from opam:
opam install data-encoding
Dependencies (12)
- ppx_hash
-
bigstringaf
>= "0.6.1" - either
- ppx_expect
-
json-data-encoding-bson
= version -
json-data-encoding
= version -
hex
>= "1.3.0" - zarith_stubs_js
-
zarith
>= "1.4" -
ezjsonm
>= "1.1.0" -
dune
>= "3.0" -
ocaml
>= "4.10"
Dev Dependencies (7)
-
conf-npm
with-test -
js_of_ocaml-compiler
with-test -
md2mld
with-test -
odoc
with-doc -
ocamlformat
= "0.24.1" & with-doc -
crowbar
>= "0.2" & with-test -
alcotest
>= "1.0.0" & with-test
Used by (7)
-
osnap
>= "0.3.0" - plebeia
-
ppx_pbt
>= "0.2.1" -
scaml
>= "1.5.0" -
tezos-bls12-381-polynomial
< "1.0.0" -
tezos-plompiler
< "1.0.0" - tezos-plonk
Conflicts
None