Module type MessageSig.SLICE
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))type``-'cap segment_t
type``-'cap message_t
type``'cap t`` = ``{
msg :'capmessage_t;(* Identifies the message of interest
*)
segment :'capsegment_t;(* Segment within message housing these bytes
*)
segment_id : int;(* Index of the segment
*)
start : int;(* Starting byte of the slice
*)
len : int;(* Length of the slice, in bytes
*)
}
Type t represents a contiguous range of bytes associated with a single
segment of a message.
alloc m size reserves size bytes of space within message m. This
may result in extending the message with an additional segment; if
storage cannot be allocated for a new segment, an exception is raised.
Note that the allocated slices always begin on an eight-byte boundary.
alloc_in_segment m seg_id size attempts to reserve size bytes of
space within segment seg_id of message m. Allocation will fail if
the segment is full.
get_segment slice gets the message segment associated with the
slice.
valget_end :'capt->int
get_end slice computes slice.start + slice.len.
get_uintXX s ofs reads an unsigned integer of the specified width,
starting at byte offset ofs within the slice.
valget_uint8 :'capt->``int->int
valget_uint16 :'capt->``int->int
get_intXX s ofs reads a signed integer of the specified width,
starting at byte offset ofs within the slice.
valget_int8 :'capt->``int->int
valget_int16 :'capt->``int->int
valget_int32 :'capt->``int->Stdlib.Int32.t
valget_int64 :'capt->``int->Stdlib.Int64.t
set_uintXX s ofs val writes the value of the width-restricted unsigned
integer val into the read/write-qualified slice, starting at byte
offset ofs.
set_intXX s ofs val writes the value of the width-restricted signed
integer val into the read/write-qualified slice, starting at byte
offset ofs.
valset_int32 :rwt->``int->Stdlib.Int32.t->unit
valset_int64 :rwt->``int->Stdlib.Int64.t->unit
blit ~src ~src_pos ~dst ~dst_pos ~len copies len bytes from the
source slice (beginning at src_pos) to the destination slice
(beginning at dst_pos).
valblit_to_bytes : ``src:'capt->``src_pos:int->``dst:Stdlib.Bytes.t->``dst_pos:int->``len:int->unit
As blit, but the destination is a bytes buffer.
As blit, but the source is a string buffer.
zero_out ~pos ~len slice sets len bytes of the slice to zero,
beginning at byte offset pos.
