mte/unikernel/duniverse/ocplib-endian/README.md

16 lines
825 B
Markdown
Raw Normal View History

2025-11-11 02:07:51 +01:00
ocplib-endian
=============
Optimised functions to read and write int16/32/64 from strings, bytes
and bigarrays, based on primitives added in version 4.01.
The library implements three modules:
- [EndianString](src/endianString.cppo.mli) works directly on strings, and provides submodules BigEndian and LittleEndian, with their unsafe counter-parts;
- [EndianBytes](src/endianBytes.cppo.mli) works directly on bytes, and provides submodules BigEndian and LittleEndian, with their unsafe counter-parts;
- [EndianBigstring](src/endianBigstring.cppo.mli) works on bigstrings (Bigarrays of chars), and provides submodules BigEndian and LittleEndian, with their unsafe counter-parts;
= Hacking =
The tests only pass in dune release profile. The debug mode prevents
cross module inlining, which prevents unboxing in the tests.