package msgpck

  1. Overview
  2. Docs

Module Msgpck.BytesSource

MessagePack library decoding from bytes and writing in bytes.

Sourcetype buf_in = Bytes.t

Type of input buffer (where MessagePack data will be read)

Sourcetype buf_out = Bytes.t

Type of output buffer (where MessagePack data will be written)

Sourceval read : ?pos:int -> buf_in -> int * t

read ?pos buf is (nb_read, t), where nb_read is the number of bytes read from buf at pos ?pos, and t is the decoded MessagePack value.

@raise Invalid_argument "msg" when there is no valid MessagePack value to be read from buf at position pos.

Sourceval read_all : ?pos:int -> buf_in -> int * t list

read_all ?pos buf reads all messages found in buf.

@raise Invalid_argument "msg" when there is no valid MessagePack value to be read from buf at position pos.

Sourceval size : t -> int

size msg is the size in bytes of the MessagePack serialization of message msg.

Sourceval write : ?pos:int -> buf_out -> t -> int

write ?pos buf msg is nb_written, the number of bytes written on buf at position ?pos. The serialization of msg have been written to buf starting at ?pos.

Sourceval to_string : t -> buf_out

to_string msg is the MessagePack serialization of msg.