Module EndianBytes
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 library to any desired (library)and/or (executable) targets in your **/dune files:
(library
(name YourLibrary)
; ... existing library options ...
(libraries
; ... existing libraries ...
ocplib-endian))
(executable
(name YourExecutable)
; ... existing executable options ...
(libraries
; ... existing libraries ...
ocplib-endian))moduletypeEndianBytesSig=sig...end
Functions reading according to Big Endian byte order
moduleBigEndian:sig...end
Functions reading according to Big Endian byte order
moduleBigEndian_unsafe:sig...end
Functions reading according to Big Endian byte order without checking for overflow
moduleLittleEndian:sig...end
Functions reading according to Little Endian byte order
moduleLittleEndian_unsafe:sig...end
Functions reading according to Big Endian byte order without checking for overflow
moduleNativeEndian:sig...end
Functions reading according to machine endianness
moduleNativeEndian_unsafe:sig...end
Functions reading according to machine endianness without checking for overflow
