package capnp

  1. Overview
  2. Docs
OCaml code generation plugin for the Cap'n Proto serialization framework

Install 

dune-project
 Dependency

github.com Changelog BSD-2-Clause License Edit opam file Versions (7)

Authors

  1. P
    Paul Pelzl <pelzlpj@gmail.com>

Maintainers

  1. P
    Paul Pelzl <pelzlpj@gmail.com>

Sources

capnp-3.6.0.tbz
sha256=d141d6ea5889fb9cc9ceef70408dd410ca0d84edae1d1208d4f90ca74ce77b18
sha512=7d70da54317c8ec13b5129343fc9558e7fe387fc41ac0524cd9363153d47cf293ea36c5d598ab04d9817292cb84d5e764c9446ae29eebcb01976b937a82192b0

doc/capnp/Capnp/Codecs/index.html

Module Capnp.CodecsSource

Sourcetype compression_t = [
  1. | `None
  2. | `Packing
]
Sourcemodule FramingError : sig ... end
Sourcemodule FramedStream : sig ... end
Sourceval 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.

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

Sourceval serialize_fold_copyless : 'cap Message.BytesMessage.Message.t -> compression:compression_t -> init:'acc -> f:('acc -> string -> int -> 'acc) -> 'acc

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

Sourceval serialize_iter_copyless : 'cap Message.BytesMessage.Message.t -> compression:compression_t -> f:(string -> int -> unit) -> unit

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

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