Module M.Segment
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))include MessageSig.SEGMENT
typestorage_t
storage_t is the type of the underlying storage associated with this
segment (e.g. "bytes").
type``-'cap t
'cap t is the type of a message segment. The 'cap annotation is type
ro for read-only segments, and type rw for read/write segments.
valalloc : ``int->MessageSig.rwt
alloc size allocates a new zero-filled message segment of at least
size bytes, raising an exception if storage cannot be allocated.
valrelease :'capt->unit
release s immediately releases the storage associated with message
segment s, potentially making the storage available for future
allocations. After releasing a storage segment, the behavior of the
accessor functions is undefined.
vallength :'capt->int
length s determines the length of this message segment.
valreadonly :'capt->MessageSig.rot
readonly s obtains a view of segment s which is read-only qualified.
valof_storage :storage_t->MessageSig.rwt
of_storage storage constructs a read/write segment which uses the
given storage for the underlying storage media.
to_storage s retrieves the underlying storage media associated with
segment s.
get_uintXX s ofs reads an unsigned integer of the specified width,
starting at byte offset ofs within message segment s.
valget_uint8 :'capt->``int->int
valget_uint16 :'capt->``int->int
valget_uint32 :'capt->``int->Stdint.Uint32.t
valget_uint64 :'capt->``int->Stdint.Uint64.t
get_intXX s ofs reads a signed integer of the specified width,
starting at byte offset ofs within message segment s.
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 read/write-qualified message segment s, starting at
byte offset ofs.
valset_uint8 :MessageSig.rwt->``int->``int->unit
valset_uint16 :MessageSig.rwt->``int->``int->unit
valset_uint32 :MessageSig.rwt->``int->Stdint.Uint32.t->unit
valset_uint64 :MessageSig.rwt->``int->Stdint.Uint64.t->unit
set_intXX s ofs val writes the value of the width-restricted signed
integer val into read/write-qualified message segment s, starting at
byte offset ofs.
valset_int8 :MessageSig.rwt->``int->``int->unit
valset_int16 :MessageSig.rwt->``int->``int->unit
valset_int32 :MessageSig.rwt->``int->Stdlib.Int32.t->unit
valset_int64 :MessageSig.rwt->``int->Stdlib.Int64.t->unit
valblit : ``src:'capt->``src_pos:int->``dst:MessageSig.rwt->``dst_pos:int->``len:int->unit
blit ~src ~src_pos ~dst ~dst_pos ~len transfers len bytes from
position dst_pos in dst to position src_pos in pos. The blit
operation shall work correctly even for the case of overlapping buffers.
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.
valblit_from_string : ``src:string->``src_pos:int->``dst:MessageSig.rwt->``dst_pos:int->``len:int->unit
As blit, but the source is a string buffer.
valzero_out :MessageSig.rwt->``pos:int->``len:int->unit
zero_out segment ~pos ~len sets len bytes of the segment to zero,
beginning at byte offset pos.
