Serialization and deserialization protocols.
The module is meant for persisting messages to and from storage, or transmitting and receiving messages over the wire.
Do not use this module for FFI.
module FramingError : sig ... endmodule FramedStreamC : sig ... endval serialize_fold :
'cap
Capnp__Message.Make(DkSDKFFIOCaml_Std__.Ffi_message.HostStorageC).Message.t ->
compression:compression_t ->
init:'acc ->
f:('acc -> string -> 'acc) ->
'accserialize_fold message ~compression ~init ~f generates an ordered sequence of string fragments corresponding to a Cap'n Proto framed message, encoded using the specified compression method. The return value is the result of folding f across the resulting sequence of fragments.
val serialize_iter :
'cap
Capnp__Message.Make(DkSDKFFIOCaml_Std__.Ffi_message.HostStorageC).Message.t ->
compression:compression_t ->
f:(string -> unit) ->
unitserialize_iter message ~compression ~f generates an ordered sequence of string fragments corresponding to a Cap'n Proto framed message, encoded using the specified compression method. f is applied to each fragment in turn.
val serialize_fold_copyless :
'cap
Capnp__Message.Make(DkSDKFFIOCaml_Std__.Ffi_message.HostStorageC).Message.t ->
compression:compression_t ->
init:'acc ->
f:('acc -> string -> int -> 'acc) ->
'accserialize_fold_copyless message ~compression ~init ~f exposes an ordered sequence of string fragments (and lengths) corresponding to a Cap'n Proto framed message, encoded using the specified compression method. The return value is the result of folding f across the resulting sequence of fragments.
val serialize_iter_copyless :
'cap
Capnp__Message.Make(DkSDKFFIOCaml_Std__.Ffi_message.HostStorageC).Message.t ->
compression:compression_t ->
f:(string -> int -> unit) ->
unitserialize_iter_copyless message ~compression ~f exposes an ordered sequence of string fragments (and lengths) corresponding to a Cap'n Proto framed message, encoded using the specified compression method. f is applied to each fragment in turn.
val serialize :
compression:compression_t ->
'cap
Capnp__Message.Make(DkSDKFFIOCaml_Std__.Ffi_message.HostStorageC).Message.t ->
stringserialize ~compression message constructs a string containing the message segments prefixed with the serialization framing header, encoded using the specified compression method.