Module Capnp.Message
Contents
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:DkSDKProject_DeclareAvailable(capnp CONSTRAINT "= 3.5.0" FINDLIBS capnp capnp.unix) DkSDKProject_MakeAvailable(capnp)Add the
Findlib::capnplibrary to any desired targets insrc/*/CMakeLists.txt:target_link_libraries(YourPackage_YourLibraryName # ... existing libraries, if any ... Findlib::capnp)Click your IDE's
Buildbutton
Not using DkSDK?
FIRST, do one or all of the following:
Run:
opam install capnp.3.5.0Edit your
dune-projectand add:(package (name YourExistingPackage) (depends ; ... existing dependenices ... (capnp (>= 3.5.0))))Then run:
dune build *.opam # if this fails, run: dune buildEdit your
<package>.opamfile and add:depends: [ # ... existing dependencies ... "capnp" {>= "3.5.0"} ]Then run:
opam install . --deps-only
FINALLY, add the capnp library to any desired (library)and/or (executable) targets in your **/dune files:
(library
(name YourLibrary)
; ... existing library options ...
(libraries
; ... existing libraries ...
capnp))
(executable
(name YourExecutable)
; ... existing executable options ...
(libraries
; ... existing libraries ...
capnp))typero`` =MessageSig.ro
typerw`` =MessageSig.rw
moduleMake(Storage:sig...end) :MessageSig.SwithtypeSegment.storage_t=Storage.tandtypeMessage.storage_t=Storage.t
moduleBytesMessage:MessageSig.SwithtypeSegment.storage_t=Stdlib.Bytes.tandtypeMessage.storage_t=Stdlib.Bytes.t
BytesMessage is the standard message format based on OCaml bytes
buffers.
exceptionInvalid_messageofstring
Invalid_message is raised by accessor functions whenever the access
cannot be completed because the message appears to be ill-formed.
exceptionOut_of_int_rangeofstring
Out_of_int_range is raised by convenience accessor functions when a
getter retrieves a value which cannot be expressed as an OCaml int.
valinvalid_msg : ``string->'a
invalid_msg err is equivalent to raise (Invalid_message err).
valout_of_int_range : ``string->'a
out_of_int_range err is equivalent to raise (Out_of_int_range err).
