package data-encoding

  1. Overview
  2. Docs
Library of JSON and binary encoding combinators

Install

Dune Dependency

gitlab.com Readme Changelog MIT License Edit opam file Versions (14)

Authors

  1. N
    Nomadic Labs

Maintainers

  1. C
    contact@nomadic-labs.com

Sources

data-encoding-v0.5.1.tar.gz
md5=c91116d318ffd0e3f5d75f307d9cc2ce
sha512=495bc4058b8fc1051d16e64ab77dea288675c39574acb603be514ee7c497be26baa0944bdc081f4faa34ba03c0b3dbd6059544375d2f2bee6c634a5ec11d899b

Description

Published: 01 Mar 2022

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)

Build and Install

data-encoding can be built from source using dune:

dune build

or installed directly from opam:

opam install data-encoding

Dev Dependencies (5)

  1. js_of_ocaml-compiler with-test
  2. odoc with-doc
  3. ocamlformat = "0.20.1" & with-doc
  4. crowbar >= "0.2" & with-test
  5. alcotest with-test

Used by (7)

  1. osnap >= "0.3.0"
  2. plebeia < "2.0.0"
  3. ppx_pbt >= "0.2.1"
  4. scaml >= "1.5.0"
  5. tezos-bls12-381-polynomial < "1.0.0"
  6. tezos-plompiler < "1.0.0"
  7. tezos-plonk

Conflicts

None