package b0

  1. Overview
  2. Docs
Software construction and deployment kit

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC; BSD-2-Clause License Edit opam file Versions (2)

Authors

  1. T
    The b0 programmers

Maintainers

  1. Daniel Bünzli

Sources

b0-0.0.5.tbz
sha512=00a6868b4dfa34565d0141b335622a81a0e8d5b9e3c6dfad025dabfa3df2db2a1302b492953bbbce30c3a4406c324fcec25250a00b38f6d18a69e15605e3b07e

doc/b0.std/B0_std/Bincode/index.html

Module B0_std.BincodeSource

Binary coding of values.

Encoders

Sourcetype 'a enc = Buffer.t -> 'a -> unit

The type for encoders of values of type 'a. The call enc b v must encode v in buffer b.

Decoders

Sourcetype 'a dec = string -> int -> int * 'a

The type for decoders of values of type 'a. The call dec s i must decode a value in s starting at i (which may be String.length s) and return the index of the byte in s after the decoded value (this can be String.length s). The function must raise Failure in case of error, use err for this.

Sourceval err : int -> ('a, Format.formatter, unit, 'b) format4 -> 'a

err i fmt reports a decoding error for position i formatted according to fmt.

Sourceval err_byte : kind:string -> int -> int -> 'a

err_byte ~kind i byte report an error for the unexpected byte byte at position i for decoding a value of type kind.

Sourceval get_byte : string -> int -> int

get_byte s i is the byte s.[i]. Does not check that i is in bounds.

Sourceval dec_eoi : string -> int -> unit

dec_eoi s i asserts that i is exactly at the end of input, i.e. String.length s.

Codecs

Sourcetype 'a t

The type for encoding and decoding values of type 'a.

Sourceval v : 'a enc -> 'a dec -> 'a t

v enc dec is a decoder using enc to encode and dec to decode.

Sourceval enc : 'a t -> 'a enc

enc c is c's encoder.

Sourceval dec : 'a t -> 'a dec

dec c is c's decoder.

Sourceval to_string : ?buf:Buffer.t -> 'a t -> 'a -> string

encode c v encodes v using c (and buf if provided, it is the client's duty to reset it before an encoding).

Sourceval of_string : ?file:Fpath.t -> 'a t -> string -> ('a, string) result

of_string ~file c s decodes a value from s using c and dec_eoi. In case of error file is mentioned in the error message (defaults to Os.File.dash).

Base codecs

Magic numbers

Sourceval enc_magic : string -> unit enc

enc_magic m encodes string m as a magic number.

Sourceval dec_magic : string -> unit dec

dec_magic m decodes magic number m and returns the next index to read from.

Sourceval magic : string -> unit t

magic m is a codec for magic number m.

Bytes

Sourceval enc_byte : int enc

enc_byte is a byte encoder. Values larger than 0xFF are truncated.

Sourceval dec_byte : kind:string -> int dec

dec_byte decodes a byte for a value of type kind (used with err_byte)

Sourceval byte : kind:string -> int t

byte codecs a byte for a value of type kind (used with err_byte).

unit

Sourceval enc_unit : unit enc

enc_unit encodes unit.

Sourceval dec_unit : unit dec

dec_unit decodes unit.

Sourceval unit : unit t

unti is a codec for unit.

bool

Sourceval enc_bool : bool enc

enc_bool encodes a boolean.

Sourceval dec_bool : bool dec

dec_bool decodes a boolean.

Sourceval bool : bool t

bool is a codec for bool.

int

Sourceval enc_int : int enc

enc_int encodes an integer. The encoding does not depend on Sys.word_size.

Sourceval dec_int : int dec

dec_int dedodes an integer. Warning. An int encoded on a 64-bit platform may end up being truncated if read back on 32-bit platform.

Sourceval int : int t

int is a codec for integers.

int64

Sourceval enc_int64 : int64 enc

enc_int64 encodes an int64.

Sourceval dec_int64 : int64 dec

dec_int64 decodes an int64.

Sourceval int64 : int64 t

int64 is a coded for int64.

string

Sourceval enc_string : string enc

enc_string encodes a string.

Sourceval dec_string : string dec

dec_string decodes a string.

Sourceval string : string t

string is a codec for string.

Fpath.t

Sourceval enc_fpath : Fpath.t enc

enc_fpath encodes an Fpath.t.

Sourceval dec_fpath : Fpath.t dec

dec_fpath decodes an Fpath.t.

Sourceval fpath : Fpath.t t

fpath is a coded for !Fpath.t.

list

Sourceval enc_list : 'a enc -> 'a list enc

enc_list enc encodes the elements of a list using enc.

Sourceval dec_list : 'a dec -> 'a list dec

dec_list dec decodes the lements of a list using dec.

Sourceval list : 'a t -> 'a list t

list c is a codec for lists of elements coded with c.

option

Sourceval enc_option : 'a enc -> 'a option enc

enc_option enc encodes an option using enc for the Some case value.

Sourceval dec_option : 'a dec -> 'a option dec

dec_option dec decodes an option using dec for the Some case value.

Sourceval option : 'a t -> 'a option t

option c is a codec for options with Some elements coded with c.

result

Sourceval enc_result : ok:'a enc -> error:'b enc -> ('a, 'b) result enc

enc_result ~ok ~error encodes a result value with the corresponding case encoders.

Sourceval dec_result : ok:'a dec -> error:'b dec -> ('a, 'b) result dec

dec_result ~ok ~error decodes a result value with the corresponding case decoders.

Sourceval result : ok:'a t -> error:'b t -> ('a, 'b) result t

result is a codec for results with Ok elements coded with ok and Error elements coded with error.

Set.t

Sourceval enc_set : (module Set.S with type elt = 'a and type t = 'set) -> 'a enc -> 'set enc

enc_set (module S) enc encodes S.t sets using enc for its elements.

Sourceval dec_set : (module Set.S with type elt = 'a and type t = 'set) -> 'a dec -> 'set dec

dec_set (module S) dec decodes S.t sets with dec for its elements.

Sourceval set : (module Set.S with type elt = 'a and type t = 'set) -> 'a t -> 'set t

set (module S) c is a codec for S.t sets using c for its elements.

Hash.t

Sourceval enc_hash : Hash.t enc

enc_hash encodes a Hash.t.

Sourceval dec_hash : Hash.t dec

dec_hash decodes a Hash.t.

Sourceval hash : Hash.t t

hash is a codec for Hash.t

Time.span

Sourceval enc_time_span : Mtime.span enc

enc_time_span encodes a Mtime.span.

Sourceval dec_time_span : Mtime.span dec

dec_time_span decodes a Mtime.span.

Sourceval time_span : Mtime.span t

time_span is a codec for Mtime.span.

Time.cpu_span

Sourceval enc_cpu_time_span : Os.Cpu.Time.span enc

enc_cpu_time_span encodes a Os.Cpu.Time.span.

Sourceval dec_cpu_time_span : Os.Cpu.Time.span dec

dec_cpu_time_span decodes a Os.Cpu.Time.span.

Sourceval cpu_time_span : Os.Cpu.Time.span t

cpu_time_span is a codec for Os.Cpu.Time.span.