Module EndianBytes.LittleEndian

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(ocplib-endian
        CONSTRAINT "= "
        FINDLIBS ocplib-endian ocplib-endian.bigstring)
    DkSDKProject_MakeAvailable(ocplib-endian)
  2. Add the Findlib::ocplib-endian library to any desired targets in src/*/CMakeLists.txt:

    Copy
    target_link_libraries(YourPackage_YourLibraryName
         # ... existing libraries, if any ...
         Findlib::ocplib-endian)
  3. Click your IDE's Build button

Not using DkSDK?

FIRST, do one or all of the following:

  1. Run:

    Copy
    opam install ocplib-endian.null
  2. Edit your dune-project and add:

    Copy
    (package
      (name YourExistingPackage)
      (depends
      ; ... existing dependenices ...
      (ocplib-endian (>= ))))

    Then run:

    Copy
    dune build *.opam # if this fails, run: dune build
  3. Edit your <package>.opam file and add:

    Copy
    depends: [
      # ... existing dependencies ...
      "ocplib-endian" {>= ""}
    ]

    Then run:

    Copy
    opam install . --deps-only

FINALLY, add the ocplib-endian library to any desired (library)and/or (executable) targets in your **/dune files:

Copy
(library
  (name YourLibrary)
  ; ... existing library options ...
  (libraries
    ; ... existing libraries ...
    ocplib-endian))

(executable
  (name YourExecutable)
  ; ... existing executable options ...
  (libraries
    ; ... existing libraries ...
    ocplib-endian))

include EndianBytesSig

valget_char :Stdlib.Bytes.t ->``int-> char

get_char buff i reads 1 byte at offset i as a char

valget_uint8 :Stdlib.Bytes.t ->``int-> int

get_uint8 buff i reads 1 byte at offset i as an unsigned int of 8 bits. i.e. It returns a value between 0 and 2^8-1

valget_int8 :Stdlib.Bytes.t ->``int-> int

get_int8 buff i reads 1 byte at offset i as a signed int of 8 bits. i.e. It returns a value between -2^7 and 2^7-1

valget_uint16 :Stdlib.Bytes.t ->``int-> int

get_uint16 buff i reads 2 bytes at offset i as an unsigned int of 16 bits. i.e. It returns a value between 0 and 2^16-1

valget_int16 :Stdlib.Bytes.t ->``int-> int

get_int16 buff i reads 2 byte at offset i as a signed int of 16 bits. i.e. It returns a value between -2^15 and 2^15-1

valget_int32 :Stdlib.Bytes.t ->``int-> int32

get_int32 buff i reads 4 bytes at offset i as an int32.

valget_int64 :Stdlib.Bytes.t ->``int-> int64

get_int64 buff i reads 8 bytes at offset i as an int64.

valget_float :Stdlib.Bytes.t ->``int-> float

get_float buff i is equivalent to Int32.float_of_bits (get_int32 buff i)

valget_double :Stdlib.Bytes.t ->``int-> float

get_double buff i is equivalent to Int64.float_of_bits (get_int64 buff i)

valset_char :Stdlib.Bytes.t ->``int->``char-> unit

set_char buff i v writes v to buff at offset i

valset_int8 :Stdlib.Bytes.t ->``int->``int-> unit

set_int8 buff i v writes the least significant 8 bits of v to buff at offset i

valset_int16 :Stdlib.Bytes.t ->``int->``int-> unit

set_int16 buff i v writes the least significant 16 bits of v to buff at offset i

valset_int32 :Stdlib.Bytes.t ->``int->``int32-> unit

set_int32 buff i v writes v to buff at offset i

valset_int64 :Stdlib.Bytes.t ->``int->``int64-> unit

set_int64 buff i v writes v to buff at offset i

valset_float :Stdlib.Bytes.t ->``int->``float-> unit

set_float buff i v is equivalent to set_int32 buff i (Int32.bits_of_float v)

valset_double :Stdlib.Bytes.t ->``int->``float-> unit

set_double buff i v is equivalent to set_int64 buff i (Int64.bits_of_float v)

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 type MessageSig.MESSAGE
            1. Module type MessageSig.S
              1. Module S.ListStorage
              1. Module S.Message
              1. Module S.Object
              1. Module S.Segment
              1. Module S.Slice
              1. Module S.StructStorage
            1. Module type MessageSig.SEGMENT
            1. Module type MessageSig.SLICE
          1. Module Capnp.RPC
              1. Module type RPC.S
                1. Module S.Capability
                1. Module S.ListStorage
                1. Module S.Message
                1. Module S.Object
                1. Module S.Segment
                1. Module S.Service
                1. Module S.Slice
                1. Module S.StructRef
                1. Module S.StructStorage
                1. Module S.Untyped
              1. Module M.ListStorage
              1. Module M.Message
              1. Module M.Object
              1. Module M.Segment
              1. Module M.Slice
              1. Module M.StructStorage
          1. Module Capnp.Runtime
        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 type Hashtbl.HashedType
              1. Module type Hashtbl.S
              1. Module type Hashtbl.SeededHashedType
              1. Module type Hashtbl.SeededS
          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 type Map.OrderedType
              1. Module type Map.S
          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 type Set.OrderedType
              1. Module type Set.S
          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 type Weak.S
        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 type EndianBigstring.EndianBigstringSig
          1. Module EndianBytes
            1. ...
            1. Module EndianBytes.LittleEndian
              1. Module type EndianBytes.EndianBytesSig
            1. ...
          1. Module EndianString
              1. Module type EndianString.EndianStringSig
      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