Codecs (p.capnp.3.4.0.doc.capnp.Capnp.Codecs)

Sourcetype compression_t = [

| `None
| `Packing

]

Sourcemodule FramingError : sig ... end

Sourcemodule FramedStream : sig ... end

val serialize_fold : 
  'cap Message.BytesMessage.Message.t ->
  compression:compression_t ->
  init:'acc ->
  f:('acc -> string -> 'acc) ->
  'acc

serialize_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.

Source

val serialize_iter : 
  'cap Message.BytesMessage.Message.t ->
  compression:compression_t ->
  f:(string -> unit) ->
  unit

serialize_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.

Source

val serialize : 
  compression:compression_t ->
  'cap Message.BytesMessage.Message.t ->
  string

serialize ~compression message constructs a string containing the message segments prefixed with the serialization framing header, encoded using the specified compression method.