Module Capnp.Codecs

Instructions: Use this module in your project

In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:

Add the following to your project's dependencies/CMakeLists.txt:

Copy

DkSDKProject_DeclareAvailable(capnp
    CONSTRAINT "= 3.5.0"
    FINDLIBS capnp capnp.unix)
DkSDKProject_MakeAvailable(capnp)

Add the Findlib::capnp library to any desired targets in src/*/CMakeLists.txt:

Copy

target_link_libraries(YourPackage_YourLibraryName
     # ... existing libraries, if any ...
     Findlib::capnp)

Click your IDE's Build button

Not using DkSDK?

FIRST, do one or all of the following:

Run:
Copy
```
opam install capnp.3.5.0
```

Edit your dune-project and add:

Copy

(package
  (name YourExistingPackage)
  (depends
  ; ... existing dependenices ...
  (capnp (>= 3.5.0))))

Then run:

Copy

dune build *.opam # if this fails, run: dune build

Edit your <package>.opam file and add:

Copy

depends: [
  # ... existing dependencies ...
  "capnp" {>= "3.5.0"}
]

Then run:

Copy

opam install . --deps-only

FINALLY, add the capnp library to any desired (library)and/or (executable) targets in your **/dune files:

Copy

(library
  (name YourLibrary)
  ; ... existing library options ...
  (libraries
    ; ... existing libraries ...
    capnp))

(executable
  (name YourExecutable)
  ; ... existing executable options ...
  (libraries
    ; ... existing libraries ...
    capnp))

typecompression_t`` = ``[


| ``` None ``

| ``` Packing `` ]

module FramingError:sig...end

module FramedStream:sig...end

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

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

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

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

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.

More from the DkSDK Book

1. DkSDK
1. 1. Package capnp
  1. 1. Module Capnp
    1. 1. ...
      1. Module Capnp.Codecs
      1. Module Codecs.FramedStream
        Module Codecs.FramingError
    1. Module Capnp_unix
  1. Package cmdliner
  1. 1. Module Cmdliner
    1. Module Cmdliner_arg
    1. Module Cmdliner_base
    1. Module Cmdliner_cline
    1. Module Cmdliner_cmd
    1. Module Cmdliner_docgen
    1. Module Cmdliner_eval
    1. Module Cmdliner_info
    1. Module Cmdliner_manpage
    1. Module Cmdliner_msg
    1. Module Cmdliner_term
    1. Module Cmdliner_term_deprecated
    1. Module Cmdliner_trie
  1. Package fmt
  1. 1. Module Fmt
    1. Module Fmt_cli
    1. Module Fmt_tty
  1. Package logs
  1. 1. Module Logs
    1. Module Logs_cli
    1. Module Logs_fmt
    1. Module Logs_lwt
    1. Module Logs_threaded
  1. Package lwt
  1. 1. Module Lwt
    1. Module Lwt_bytes
    1. Module Lwt_condition
    1. Module Lwt_config
    1. Module Lwt_engine
    1. Module Lwt_features
    1. Module Lwt_fmt
    1. Module Lwt_gc
    1. Module Lwt_io
    1. Module Lwt_list
    1. Module Lwt_main
    1. Module Lwt_mutex
    1. Module Lwt_mvar
    1. Module Lwt_pool
    1. Module Lwt_pqueue
    1. Module Lwt_preemptive
    1. Module Lwt_process
    1. Module Lwt_result
    1. Module Lwt_seq
    1. Module Lwt_sequence
    1. Module Lwt_stream
    1. Module Lwt_switch
    1. Module Lwt_sys
    1. Module Lwt_throttle
    1. Module Lwt_timeout
    1. Module Lwt_unix
  1. Package mtime
  1. 1. Module Mtime
    1. Module Mtime_clock
  1. Package ocaml
  1. 1. Module Bigarray
    1. Module Condition
    1. Module Dynlink
    1. Module Event
    1. Module Mutex
    1. Module Profiling
    1. Module Semaphore
    1. Module Stdlib
    1. Module Str
    1. Module Thread
    1. Module ThreadUnix
    1. Module Topdirs
    1. Module Unix
    1. Module UnixLabels
  1. Package
  1. Package result
  1. 1. Module Result
  1. Package stdint
  1. 1. Module Stdint