Module Runtime.FragmentBuffer
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))typet
valempty : ``unit->t
Create a new, empty fragment buffer.
valof_string : ``string->t
Create a new fragment buffer containing the contents of the string.
valbyte_count :t->int
Get the number of bytes stored in the fragment buffer.
valadd_fragment :t->``string->unit
Add a fragment to the back of the fragment buffer.
valremove_exact :t->``int->``string option
Remove a specific number of bytes from the front of the fragment buffer.
valremove_at_least :t->``int->``string option
Remove at least the specified number of bytes from the front of the
fragment buffer. This is a less expensive operation than remove_exact.
valpeek_exact :t->``int->``string option
Examine a specific number of bytes from the front of the fragment buffer, without removing the data.
valunremove :t->``string->unit
Return some bytes to the front of the fragment buffer.
