package data-encoding

You can search for identifiers within the package.

in-package search v0.2.0

data-encoding
- Data_encoding
  - Binary
    
    Slicer
  - Binary_schema
  - Bounded
  - Bson
  - Encoding
    
    Bounded
    
    Fixed
    
    Variable
  - Fixed
  - Json
  - Registration
  - Variable
  - With_version

Legend:
Library
Module
Module type
Parameter
Class
Class type

type id = string

type t

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

val binary_schema : t -> Binary_schema.t

Descriptions and schemas of registered encodings.

val json_schema : t -> Json.schema

val description : t -> string option

val json_pretty_printer : t -> Stdlib.Format.formatter -> Json.t -> unit

Printers for the encodings.

val binary_pretty_printer : 
  t ->
  Stdlib.Format.formatter ->
  Stdlib.Bytes.t ->
  unit

val register : 
  ?pp:(Stdlib.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.

val slice : 
  t ->
  string ->
  (Binary.Slicer.slice list, Binary.read_error) Stdlib.result

slice r b attempts to slice a binary representation b of some data assuming it is correctly described by the registered encoding r. If r does not correctly describe b, then it returns None.

See Binary.slice_string for details about slicing.

val slice_all : string -> (string * Binary.Slicer.slice list) list

slice_all b attempts to slice a binary representation b of some data for all of the registered encodings. It returns a list of the slicing for each of the registered encodings that correctly describe b.

See Binary.slice_string for details about slicing.

val 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.

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

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

val bytes_of_json : t -> Json.t -> Stdlib.Bytes.t option

Conversion functions from/to json to/from bytes.

val json_of_bytes : t -> Stdlib.Bytes.t -> Json.t option