Concise Binary Object Representation (CBOR) flyweight implementation.
This module provides flyweight encoding and decoding of Concise Binary Object Representation (CBOR) structured data.
Use the flyweight implementation when values are not very large, streaming is not required, integer and floating point values do not exceed the limits of representation for OCaml primitive int and float types, lengths of octet arrays and Unicode texts do not exceed the limits of the OCaml string type, no special handling is required for standard CBOR tags, no Unicode normalization is required, and the order/uniqueness properties of key-value pairs in maps is not required to be deterministic.
The encoder never emits indefinite-length sequence events. The decoder can scan them and reconstruct fixed-length sequences from them accordingly.
The functions below guard construction of flyweight values to respect the invariants of the CBOR encoding, e.g. tag values must be non-negative integers, text strings should comprise valid UTF-8 encodings, an "undefined" value can only be constructed by decoders, et cetera.
val null : tThe distinguished "null" value.
val boolean : bool -> tUse boolean b to make a boolean value with b.
val integer : int -> tUse integer i to make an integer value with i.
val float : float -> tUse float n to make a floating-point value with n.
val octets : string -> tUse octets s to make an octet sequence value with s.
val text : ?unsafe:unit -> string -> tUse text s to make a Unicode text value with b. If s is not valid UTF-8 and ~unsafe:() is not used, then Cf_decode.Invalid is raised.
val decoder : t Cf_decode.schemeThe decoder for flyweight CBOR values.
val encoder : t Cf_encode.schemeThe encoder for flyweight CBOR values.