package data-encoding

  1. Overview
  2. Docs

Module Data_encoding.RegistrationSource

Sourcetype id = string
Sourcetype t

A encoding that has been registered. It can be retreived using either list or find.

Sourceval binary_schema : t -> Binary_schema.t

Descriptions and schemas of registered encodings.

Sourceval json_schema : t -> Json.schema
Sourceval description : t -> string option
Sourceval json_pretty_printer : t -> Format.formatter -> Json.t -> unit

Printers for the encodings.

Sourceval binary_pretty_printer : t -> Format.formatter -> Bytes.t -> unit
Sourceval register : ?pp:(Format.formatter -> 'a -> unit) -> 'a Encoding.t -> unit

register ~id encoding registers the encoding with the id. It can later be found using find and providing the matching id. It will also appear in the results of list.

Sourceval find : id -> t option

find id is Some r if register id e has been called, in which case r matches e. Otherwise, it is None.

Sourceval list : unit -> (id * t) list

list () is a list of pairs (id, r) where r is a registered encoding for the id.

Sourceval bytes_of_json : t -> Json.t -> Bytes.t option

Conversion functions from/to json to/from bytes.

Sourceval json_of_bytes : t -> Bytes.t -> Json.t option
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct