package data-encoding

You can search for identifiers within the package.

in-package search v0.2.0

data-encoding
- Library data-encoding
  - Data_encoding
    
    Encoding
    
    Fixed
    
    Variable
    
    Bounded
    
    Fixed
    
    Variable
    
    Bounded
    
    With_version
    
    Json
    
    Bson
    
    Binary_schema
    
    Binary
    
    Slicer
    
    Registration
- Sources
  - data-encoding
    
    binary_description.ml
    
    binary_error.ml
    
    binary_error_types.ml
    
    binary_length.ml
    
    binary_reader.ml
    
    binary_schema.ml
    
    binary_size.ml
    
    binary_slicer.ml
    
    binary_stream.ml
    
    binary_stream_reader.ml
    
    binary_writer.ml
    
    bson.ml
    
    data_encoding.ml
    
    data_encoding__.ml
    
    encoding.ml
    
    json.ml
    
    json_stream.ml
    
    registration.ml
    
    tzEndian.ml
    
    uint_option.ml
    
    with_version.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Data_encoding.Registration`Source

Sourcetype id = string

Sourcetype t

A encoding that has been registered. It can be retrieved 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 slice : t -> string -> (Binary.Slicer.slice list, Binary.read_error) 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.

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

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

package data-encoding

Module Data_encoding.RegistrationSource

Module `Data_encoding.Registration`Source