Module EndianBigstring.BigEndian
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(ocplib-endian CONSTRAINT "= " FINDLIBS ocplib-endian ocplib-endian.bigstring) DkSDKProject_MakeAvailable(ocplib-endian)Add the
Findlib::ocplib-endianlibrary to any desired targets insrc/*/CMakeLists.txt:target_link_libraries(YourPackage_YourLibraryName # ... existing libraries, if any ... Findlib::ocplib-endian)Click your IDE's
Buildbutton
Not using DkSDK?
FIRST, do one or all of the following:
Run:
opam install ocplib-endian.nullEdit your
dune-projectand add:(package (name YourExistingPackage) (depends ; ... existing dependenices ... (ocplib-endian (>= ))))Then run:
dune build *.opam # if this fails, run: dune buildEdit your
<package>.opamfile and add:depends: [ # ... existing dependencies ... "ocplib-endian" {>= ""} ]Then run:
opam install . --deps-only
FINALLY, add the ocplib-endian.bigstring library to any desired (library)and/or (executable) targets in your **/dune files:
(library
(name YourLibrary)
; ... existing library options ...
(libraries
; ... existing libraries ...
ocplib-endian.bigstring))
(executable
(name YourExecutable)
; ... existing executable options ...
(libraries
; ... existing libraries ...
ocplib-endian.bigstring))include EndianBigstringSig
valget_char :bigstring->``int->char
get_char buff i reads 1 byte at offset i as a char
valget_uint8 :bigstring->``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 :bigstring->``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 :bigstring->``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 :bigstring->``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 :bigstring->``int->int32
get_int32 buff i reads 4 bytes at offset i as an int32.
valget_int64 :bigstring->``int->int64
get_int64 buff i reads 8 bytes at offset i as an int64.
valget_float :bigstring->``int->float
get_float buff i is equivalent to
Int32.float_of_bits (get_int32 buff i)
valget_double :bigstring->``int->float
get_double buff i is equivalent to
Int64.float_of_bits (get_int64 buff i)
valset_char :bigstring->``int->``char->unit
set_char buff i v writes v to buff at offset i
valset_int8 :bigstring->``int->``int->unit
set_int8 buff i v writes the least significant 8 bits of v to buff
at offset i
valset_int16 :bigstring->``int->``int->unit
set_int16 buff i v writes the least significant 16 bits of v to
buff at offset i
valset_int32 :bigstring->``int->``int32->unit
set_int32 buff i v writes v to buff at offset i
valset_int64 :bigstring->``int->``int64->unit
set_int64 buff i v writes v to buff at offset i
valset_float :bigstring->``int->``float->unit
set_float buff i v is equivalent to
set_int32 buff i (Int32.bits_of_float v)
valset_double :bigstring->``int->``float->unit
set_double buff i v is equivalent to
set_int64 buff i (Int64.bits_of_float v)
