Module Runtime.Packing

Contents

Instructions: Use this module in your project

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

  1. 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)

  2. 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)

  3. Click your IDE's Build button

Not using DkSDK?

FIRST, do one or all of the following:

  1. Run:

    Copy
    opam install capnp.3.5.0

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

  3. 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))
valcount_zeros : ``start:int->``stop:int->``string-> int
type output_buffers_t`` = ``{

    

  1. 

output_buf : Stdlib.Buffer.t;
    

  1. 

lit_buf : Stdlib.Buffer.t;
    

  1. 

tagged_bytes : Stdlib.Bytes.t;}
valpack_loop_words : ``input:string->``ofs:int-> ``buffers:output_buffers_t -> string
valpack_loop_bytes : ``input:string->``ofs:int-> ``buffers:output_buffers_t -> string
valpack_loop_zero_words : ``input:string->``ofs:int->``count:int-> ``buffers:output_buffers_t -> string
valpack_loop_literal_words : ``input:string->``ofs:int-> ``buffers:output_buffers_t ->``count:int-> string
valpack_string : ``string-> string

Pack a word_aligned string.

val bits_set_lookup : ``int array
valbits_set : ``int-> int
module MixedContext:sig...end
val transfer_mixed_bytes : ``unpacked:Capnp__.FragmentBuffer.t -> ``mixed_context:MixedContext.t -> unit
val unpack_coalesce_buffer_and_retry : ``packed:Capnp__.FragmentBuffer.t -> ``unpacked:Capnp__.FragmentBuffer.t ->``buf:string->``ofs:int-> ``mixed_context:MixedContext.t ->``required_byte_count:int-> unit
val unpack_zeros : ``packed:Capnp__.FragmentBuffer.t -> ``unpacked:Capnp__.FragmentBuffer.t ->``buf:string->``ofs:int-> ``mixed_context:MixedContext.t -> unit
val unpack_literal_bytes : ``packed:Capnp__.FragmentBuffer.t -> ``unpacked:Capnp__.FragmentBuffer.t ->``buf:string->``ofs:int-> ``mixed_context:MixedContext.t -> unit
val unpack_mixed_bytes : ``packed:Capnp__.FragmentBuffer.t -> ``unpacked:Capnp__.FragmentBuffer.t ->``buf:string->``ofs:int-> ``mixed_context:MixedContext.t ->``tag:char-> unit
val unpack_decode_tag : ``packed:Capnp__.FragmentBuffer.t -> ``unpacked:Capnp__.FragmentBuffer.t ->``buf:string->``ofs:int-> ``mixed_context:MixedContext.t -> unit
val unpack : ``packed:Capnp__.FragmentBuffer.t -> ``unpacked:Capnp__.FragmentBuffer.t -> unit

Unpack as much data as possible from the packed fragment buffer. into the unpacked fragment buffer.

valunpack_string : ``string-> string

More from the DkSDK Book

    1. DkSDK
      1. Package capnp
        1. Module Capnp
          1. Module Capnp.Array
          1. Module Capnp.BytesStorage
          1. Module Capnp.Codecs
          1. Module Capnp.Message
          1. Module Capnp.MessageSig
          1. Module Capnp.RPC
          1. Module Capnp.Runtime
            1. ...
            1. Module Runtime.Packing
              1. Module Packing.MixedContext
            1. ...
        1. Module Capnp_unix
          1. Module Capnp_unix.IO
      1. Package cmdliner
        1. Module Cmdliner
          1. Module Cmdliner.Arg
          1. Module Cmdliner.Cmd
          1. Module Cmdliner.Manpage
          1. Module Cmdliner.Term
        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_info.Arg
          1. Module Cmdliner_info.Cmd
          1. Module Cmdliner_info.Env
          1. Module Cmdliner_info.Eval
          1. Module Cmdliner_info.Exit
        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. Module Fmt
          1. Module Fmt.Dump
        1. Module Fmt_cli
        1. Module Fmt_tty
      1. Package logs
        1. Module Logs
        1. Module Logs_cli
        1. Module Logs_fmt
        1. Module Logs_lwt
        1. Module Logs_threaded
      1. Package lwt
        1. Module Lwt
          1. Module Lwt.Infix
          1. Module Lwt.Let_syntax
          1. Module Lwt.Syntax
        1. Module Lwt_bytes
        1. Module Lwt_condition
        1. Module Lwt_config
        1. Module Lwt_engine
          1. Module Lwt_engine.Ev_backend
          1. Module Lwt_engine.Versioned
        1. Module Lwt_features
        1. Module Lwt_fmt
        1. Module Lwt_gc
        1. Module Lwt_io
          1. Module Lwt_io.BE
          1. Module Lwt_io.LE
          1. Module Lwt_io.Versioned
        1. Module Lwt_list
        1. Module Lwt_main
          1. Module Lwt_main.Enter_iter_hooks
          1. Module Lwt_main.Exit_hooks
          1. Module Lwt_main.Leave_iter_hooks
        1. Module Lwt_mutex
        1. Module Lwt_mvar
        1. Module Lwt_pool
        1. Module Lwt_pqueue
          1. Module Lwt_pqueue.Make
        1. Module Lwt_preemptive
        1. Module Lwt_process
        1. Module Lwt_result
          1. Module Lwt_result.Infix
          1. Module Lwt_result.Let_syntax
          1. Module Lwt_result.Syntax
        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_throttle.Make
        1. Module Lwt_timeout
        1. Module Lwt_unix
          1. Module Lwt_unix.IO_vectors
          1. Module Lwt_unix.LargeFile
          1. Module Lwt_unix.Versioned
      1. Package mtime
        1. Module Mtime
          1. Module Mtime.Span
        1. Module Mtime_clock
      1. Package ocaml
        1. Module Bigarray
        1. Module Condition
        1. Module Dynlink
        1. Module Event
        1. Module Mutex
        1. Module Profiling
        1. Module Semaphore
          1. Module Semaphore.Binary
          1. Module Semaphore.Counting
        1. Module Stdlib
          1. Module Stdlib.Arg
          1. Module Stdlib.Array
          1. Module Stdlib.ArrayLabels
          1. Module Stdlib.Atomic
          1. Module Stdlib.Bigarray
          1. Module Stdlib.Bool
          1. Module Stdlib.Buffer
          1. Module Stdlib.Bytes
          1. Module Stdlib.BytesLabels
          1. Module Stdlib.Callback
          1. Module Stdlib.Char
          1. Module Stdlib.Complex
          1. Module Stdlib.Digest
          1. Module Stdlib.Either
          1. Module Stdlib.Ephemeron
          1. Module Stdlib.Filename
          1. Module Stdlib.Float
          1. Module Stdlib.Format
          1. Module Stdlib.Fun
          1. Module Stdlib.Gc
          1. Module Stdlib.Genlex
          1. Module Stdlib.Hashtbl
          1. Module Stdlib.In_channel
          1. Module Stdlib.Int
          1. Module Stdlib.Int32
          1. Module Stdlib.Int64
          1. Module Stdlib.LargeFile
          1. Module Stdlib.Lazy
          1. Module Stdlib.Lexing
          1. Module Stdlib.List
          1. Module Stdlib.ListLabels
          1. Module Stdlib.Map
          1. Module Stdlib.Marshal
          1. Module Stdlib.MoreLabels
          1. Module Stdlib.Nativeint
          1. Module Stdlib.Obj
          1. Module Stdlib.Oo
          1. Module Stdlib.Option
          1. Module Stdlib.Out_channel
          1. Module Stdlib.Parsing
          1. Module Stdlib.Pervasives
          1. Module Stdlib.Printexc
          1. Module Stdlib.Printf
          1. Module Stdlib.Queue
          1. Module Stdlib.Random
          1. Module Stdlib.Result
          1. Module Stdlib.Scanf
          1. Module Stdlib.Seq
          1. Module Stdlib.Set
          1. Module Stdlib.Stack
          1. Module Stdlib.StdLabels
          1. Module Stdlib.Stream
          1. Module Stdlib.String
          1. Module Stdlib.StringLabels
          1. Module Stdlib.Sys
          1. Module Stdlib.Uchar
          1. Module Stdlib.Unit
          1. Module Stdlib.Weak
        1. Module Str
        1. Module Thread
        1. Module ThreadUnix
        1. Module Topdirs
        1. Module Unix
          1. Module Unix.LargeFile
        1. Module UnixLabels
          1. Module UnixLabels.LargeFile
          1. Module EndianBigstring
          1. Module EndianBytes
          1. Module EndianString
      1. Package
      1. Package result
        1. Module Result
      1. Package stdint
        1. Module Stdint
          1. Module Stdint.Int128
          1. Module Stdint.Int16
          1. Module Stdint.Int24
          1. Module Stdint.Int32
          1. Module Stdint.Int40
          1. Module Stdint.Int48
          1. Module Stdint.Int56
          1. Module Stdint.Int64
          1. Module Stdint.Int8
          1. Module Stdint.Uint128
          1. Module Stdint.Uint16
          1. Module Stdint.Uint24
          1. Module Stdint.Uint32
          1. Module Stdint.Uint40
          1. Module Stdint.Uint48
          1. Module Stdint.Uint56
          1. Module Stdint.Uint64
          1. Module Stdint.Uint8
Logo for Diskuv

The development kit to create safe software and products.