Utils

#

val size_header_length : int

size_header_length is the standard number of bytes allocated for the size header in size-prefixed bin-io payloads. This size-prefixed layout is used by the bin_dump and bin_read_stream functions below, as well as:

Core.Std.Bigstring. CUSTOM(read) ,write _bin_prot
Core.Std.Unpack_buffer.unpack_bin_prot
Async.Std. CUSTOM(Reader) ,Writer . CUSTOM(read) ,write _bin_prot among others.

The size prefix is always 8 bytes at present. This is exposed so your program does not have to know this fact too.

We do not use a variable length header because we want to know how many bytes to read to get the size without having to peek into the payload.

#

val bin_read_size_header : int Read.reader

#

val bin_write_size_header : int Write.writer

bin_read_size_header and bin_write_size_header are bin-prot serializers for the size header described above.

#

val bin_dump : ?header:bool -> 'a Type_class.writer -> 'a -> Common.buf

bin_dump ?header writer v uses writer to first compute the size of v in the binary protocol, then allocates a buffer of exactly this size, and then writes out the value. If header is true, the size of the resulting binary string will be prefixed as a signed 64bit integer.

Returns the buffer containing the written out value.

header default = false

Raises Failure if the size of the value changes during writing, and any other exceptions that the binary writer in writer can raise.

#

val bin_read_stream : ?max_size:int -> read:(Common.buf -> pos:int -> len:int -> unit) -> 'a Type_class.reader -> 'a

bin_read_stream ?max_size ~read reader reads binary protocol data from a stream as generated by the read function, which places data of a given length into a given buffer. Requires a header. The reader type class will be used for conversion to OCaml-values.

max_size = nothing

Raises Failure if the size of the value disagrees with the one specified in the header, and any other exceptions that the binary reader associated with reader can raise.

Raises Failure if the size reported in the data header is longer than max_size.

#

module type Make_binable_spec = sig

#

module Binable : Binable.S

#

type t

#

val to_binable : t -> Binable.t

#

val of_binable : Binable.t -> t

end

#

module Make_binable : functor (Bin_spec : Make_binable_spec) -> Binable.S with type t := Bin_spec.t

#

module type Make_binable1_spec = sig

#

module Binable : Binable.S1

#

type 'a t

#

val to_binable : 'a t -> 'a Binable.t

#

val of_binable : 'a Binable.t -> 'a t

end

#

module Make_binable1 : functor (Bin_spec : Make_binable1_spec) -> Binable.S1 with type 'a t := 'a Bin_spec.t

#

module type Make_binable2_spec = sig

#

module Binable : Binable.S2

#

type ('a, 'b) t

#

val to_binable : ('a, 'b) t -> ('a, 'b) Binable.t

#

val of_binable : ('a, 'b) Binable.t -> ('a, 'b) t

end

#

module Make_binable2 : functor (Bin_spec : Make_binable2_spec) -> Binable.S2 with type ('a, 'b) t := ('a, 'b) Bin_spec.t

#

module type Make_iterable_binable_spec = sig

#

type t

#

type el

#

type acc

#

val module_name : string option

#

val length : t -> int

#

val iter : t -> f:(el -> unit) -> unit

#

val init : int -> acc

#

val insert : acc -> el -> int -> acc

#

val finish : acc -> t

#

val bin_size_el : el Size.sizer

#

val bin_write_el : el Write.writer

#

val bin_read_el : el Read.reader

end

#

module Make_iterable_binable : functor (Iterable_spec : Make_iterable_binable_spec) -> Binable.S with type t := Iterable_spec.t

#

module type Make_iterable_binable1_spec = sig

#

type 'a t

#

type 'a el

#

type 'a acc

#

val module_name : string option

#

val length : 'a t -> int

#

val iter : 'a t -> f:('a el -> unit) -> unit

#

val init : int -> 'a acc

#

val insert : 'a acc -> 'a el -> int -> 'a acc

#

val finish : 'a acc -> 'a t

#

val bin_size_el : ('a, 'a el) Size.sizer1

#

val bin_write_el : ('a, 'a el) Write.writer1

#

val bin_read_el : ('a, 'a el) Read.reader1

end

#

module Make_iterable_binable1 : functor (Iterable_spec : Make_iterable_binable1_spec) -> Binable.S1 with type 'a t := 'a Iterable_spec.t

#

module type Make_iterable_binable2_spec = sig

#

type ('a, 'b) t

#

type ('a, 'b) el

#

type ('a, 'b) acc

#

val module_name : string option

#

val length : ('a, 'b) t -> int

#

val iter : ('a, 'b) t -> f:(('a, 'b) el -> unit) -> unit

#

val init : int -> ('a, 'b) acc

#

val insert : ('a, 'b) acc -> ('a, 'b) el -> int -> ('a, 'b) acc

#

val finish : ('a, 'b) acc -> ('a, 'b) t

#

val bin_size_el : ('a, 'b, ('a, 'b) el) Size.sizer2

#

val bin_write_el : ('a, 'b, ('a, 'b) el) Write.writer2

#

val bin_read_el : ('a, 'b, ('a, 'b) el) Read.reader2

end

#

module Make_iterable_binable2 : functor (Iterable_spec : Make_iterable_binable2_spec) -> Binable.S2 with type ('a, 'b) t := ('a, 'b) Iterable_spec.t

module Utils