Module Serialize

module Serialize: sig  end

Packing objects into net transferable buffers

type 'a t = (Buffer.t -> 'a -> unit) * (string -> int -> int -> int * 'a) 

Type representing a serializer of an object.

It is a pair (writer, reader). writer is adds the given value to the buffer. reader takes a message starting position and length of the message and returns the new position and the value that has been read

exception Too_short of string

Exception raised when the message is too short for the reader to read it's value

Every serializer should check if the message is long enought to read its value and if not should raise this exception

val unit : unit t

An empty serializer

val char : char t

Character serializer

val int : int t

Integer value serializer. The size of the serialized value depends on the integer:

1b -64 to 64
2b -8k to 8k
3b -1M to 1M
4b -128M to 128M
5b bigger

val float : float t

val string : string t

String serializer. Its length as Serialize.int and the contents.

val int31 : int t

Deprecated. 31bit integer serializer that always uses 4 bytes.

val pair : 'a t -> 'b t -> ('a * 'b) t

Concatenation of its elements

val list : 'a t -> 'a list t

List length as Serialize.int and its elements concateneted.

val map : 'a t -> ('a -> 'b) -> ('b -> 'a) -> 'b t

val marshal : 'a t

A marshaling serializer. Can serialize a value of any type, but is not safe nor optimal. Every serialization has additional header which is about 20bytes long