package cborl

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

CBOR Data Item
Serialization
1. Signals

cborl
- Cborl
  - Signal

Legend:
Library
Module
Module type
Parameter
Class
Class type

OCaml implementation of The Concise Binary Object Representation (CBOR)

This module provides types for CBOR data items as well as function for writing CBOR data items to sequences of bytes and reading CBOR data items from sequences of bytes.

see https://www.rfc-editor.org/rfc/rfc8949.html
RFC 8949 Concise Binary Object Representation (CBOR)

CBOR Data Item

type item =

| Null
| Undefined
| Bool of bool
| Integer of Z.t
| ByteString of string
| TextString of string
| Array of item list
| Map of (item * item) list
| Tag of Z.t * item
| Simple of int
| Float of float
| Double of float

Type of CBOR data item

val pp : item Fmt.t

CBOR data item pretty printer. Output resembles the CBOR diagnostic notation.

val equal : item -> item -> bool

equal a b returns true if a is structurally equal to b.

Serialization

val read : char Stdlib.Seq.t -> item

read bytes read a single CBOR data item from the sequence bytes.

To read multiple data items (i.e. a CBOR data stream) see Signal.to_items.

val write : item -> char Stdlib.Seq.t

write item returns a sequence of bytes that encodes item.

Signals

module Signal : sig ... end

Serialization is done by converting CBOR data items to a sequence of signals. Signals can be directly translated to and from bytes. This module provides direct access to signals. This can be used to stream large CBOR data items and also provides the ability to work with indefinite-length CBOR data items.