Module Stdlib.BytesLabels
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(ocaml CONSTRAINT "= 4.14.0" FINDLIBS str unix runtime_events threads dynlink) DkSDKProject_MakeAvailable(ocaml)Add the
Findlib::ocamllibrary to any desired targets insrc/*/CMakeLists.txt:target_link_libraries(YourPackage_YourLibraryName # ... existing libraries, if any ... Findlib::ocaml)Click your IDE's
Buildbutton
Not using DkSDK?
FIRST, do one or all of the following:
Run:
opam install ocaml.4.14.0Edit your
dune-projectand add:(package (name YourExistingPackage) (depends ; ... existing dependenices ... (ocaml (>= 4.14.0))))Then run:
dune build *.opam # if this fails, run: dune buildEdit your
<package>.opamfile and add:depends: [ # ... existing dependencies ... "ocaml" {>= "4.14.0"} ]Then run:
opam install . --deps-only
FINALLY, add the library to any desired (library)and/or (executable) targets in your **/dune files:
(library
(name YourLibrary)
; ... existing library options ...
(libraries
; ... existing libraries ...
))
(executable
(name YourExecutable)
; ... existing executable options ...
(libraries
; ... existing libraries ...
))vallength : ``bytes->int
Return the length (number of bytes) of the argument.
valget : ``bytes->``int->char
get s n returns the byte at index n in argument s.
-
raises Invalid_argument
if
nis not a valid index ins.
valset : ``bytes->``int->``char->unit
set s n c modifies s in place, replacing the byte at index n with
c.
-
raises Invalid_argument
if
nis not a valid index ins.
valcreate : ``int->bytes
create n returns a new byte sequence of length n. The sequence is
uninitialized and contains arbitrary bytes.
-
raises Invalid_argument
if
n < 0orn >Sys.max_string_length.
valmake : ``int->``char->bytes
make n c returns a new byte sequence of length n, filled with the
byte c.
-
raises Invalid_argument
if
n < 0orn >Sys.max_string_length.
valinit : ``int->``f:``(``int->char)``->bytes
init n f returns a fresh byte sequence of length n, with character
i initialized to the result of f i (in increasing index order).
-
raises Invalid_argument
if
n < 0orn >Sys.max_string_length.
valempty : bytes
A byte sequence of size 0.
valcopy : ``bytes->bytes
Return a new byte sequence that contains the same bytes as the argument.
valof_string : ``string->bytes
Return a new byte sequence that contains the same bytes as the given string.
valto_string : ``bytes->string
Return a new string that contains the same bytes as the given byte sequence.
valsub : ``bytes->``pos:int->``len:int->bytes
sub s ~pos ~len returns a new byte sequence of length len,
containing the subsequence of s that starts at position pos and has
length len.
-
raises Invalid_argument
if
posandlendo not designate a valid range ofs.
valsub_string : ``bytes->``pos:int->``len:int->string
Same as sub but return a string instead of a byte
sequence.
valextend : ``bytes->``left:int->``right:int->bytes
extend s ~left ~right returns a new byte sequence that contains the
bytes of s, with left uninitialized bytes prepended and right
uninitialized bytes appended to it. If left or right is negative,
then bytes are removed (instead of appended) from the corresponding side
of s.
-
raises Invalid_argument
if the result length is negative or longer than
Sys.max_string_lengthbytes. -
since 4.05.0 in BytesLabels
valfill : ``bytes->``pos:int->``len:int->``char->unit
fill s ~pos ~len c modifies s in place, replacing len characters
with c, starting at pos.
-
raises Invalid_argument
if
posandlendo not designate a valid range ofs.
valblit : ``src:bytes->``src_pos:int->``dst:bytes->``dst_pos:int->``len:int->unit
blit ~src ~src_pos ~dst ~dst_pos ~len copies len bytes from sequence
src, starting at index src_pos, to sequence dst, starting at index
dst_pos. It works correctly even if src and dst are the same byte
sequence, and the source and destination intervals overlap.
-
raises Invalid_argument
if
src_posandlendo not designate a valid range ofsrc, or ifdst_posandlendo not designate a valid range ofdst.
valblit_string : ``src:string->``src_pos:int->``dst:bytes->``dst_pos:int->``len:int->unit
blit ~src ~src_pos ~dst ~dst_pos ~len copies len bytes from string
src, starting at index src_pos, to byte sequence dst, starting at
index dst_pos.
-
raises Invalid_argument
if
src_posandlendo not designate a valid range ofsrc, or ifdst_posandlendo not designate a valid range ofdst. -
since 4.05.0 in BytesLabels
valconcat : ``sep:bytes->``bytes list``->bytes
concat ~sep sl concatenates the list of byte sequences sl, inserting
the separator byte sequence sep between each, and returns the result
as a new byte sequence.
-
raises Invalid_argument
if the result is longer than
Sys.max_string_lengthbytes.
valcat : ``bytes->``bytes->bytes
cat s1 s2 concatenates s1 and s2 and returns the result as a new
byte sequence.
-
raises Invalid_argument
if the result is longer than
Sys.max_string_lengthbytes. -
since 4.05.0 in BytesLabels
valiter : ``f:``(``char->unit)``->``bytes->unit
iter ~f s applies function f in turn to all the bytes of s. It is
equivalent to
f (get s 0); f (get s 1); ...; f (get s (length s - 1)); ().
valiteri : ``f:``(``int->``char->unit)``->``bytes->unit
Same as iter, but the function is applied to the index of
the byte as first argument and the byte itself as second argument.
valmap : ``f:``(``char->char)``->``bytes->bytes
map ~f s applies function f in turn to all the bytes of s (in
increasing index order) and stores the resulting bytes in a new sequence
that is returned as the result.
valmapi : ``f:``(``int->``char->char)``->``bytes->bytes
mapi ~f s calls f with each character of s and its index (in
increasing index order) and stores the resulting bytes in a new sequence
that is returned as the result.
valfold_left : ``f:``('a->``char->'a)``->``init:'a->``bytes->'a
fold_left f x s computes
f (... (f (f x (get s 0)) (get s 1)) ...) (get s (n-1)), where n is
the length of s.
- since 4.13.0
valfold_right : ``f:``(``char->'a->'a)``->``bytes->``init:'a->'a
fold_right f s x computes
f (get s 0) (f (get s 1) ( ... (f (get s (n-1)) x) ...)), where n is
the length of s.
- since 4.13.0
valfor_all : ``f:``(``char->bool)``->``bytes->bool
for_all p s checks if all characters in s satisfy the predicate p.
- since 4.13.0
valexists : ``f:``(``char->bool)``->``bytes->bool
exists p s checks if at least one character of s satisfies the
predicate p.
- since 4.13.0
valtrim : ``bytes->bytes
Return a copy of the argument, without leading and trailing whitespace.
The bytes regarded as whitespace are the ASCII characters ' ',
'\012', '\n', '\r', and '\t'.
valescaped : ``bytes->bytes
Return a copy of the argument, with special characters represented by escape sequences, following the lexical conventions of OCaml. All characters outside the ASCII printable range (32..126) are escaped, as well as backslash and double-quote.
-
raises Invalid_argument
if the result is longer than
Sys.max_string_lengthbytes.
valindex : ``bytes->``char->int
index s c returns the index of the first occurrence of byte c in
s.
-
raises Not_found
if
cdoes not occur ins.
valindex_opt : ``bytes->``char->``int option
index_opt s c returns the index of the first occurrence of byte c in
s or None if c does not occur in s.
- since 4.05
valrindex : ``bytes->``char->int
rindex s c returns the index of the last occurrence of byte c in
s.
-
raises Not_found
if
cdoes not occur ins.
valrindex_opt : ``bytes->``char->``int option
rindex_opt s c returns the index of the last occurrence of byte c in
s or None if c does not occur in s.
- since 4.05
valindex_from : ``bytes->``int->``char->int
index_from s i c returns the index of the first occurrence of byte c
in s after position i. index s c is equivalent to
index_from s 0 c.
-
raises Invalid_argument
if
iis not a valid position ins. -
raises Not_found
if
cdoes not occur insafter positioni.
valindex_from_opt : ``bytes->``int->``char->``int option
index_from_opt s i c returns the index of the first occurrence of byte
c in s after position i or None if c does not occur in s
after position i. index_opt s c is equivalent to
index_from_opt s 0 c.
-
raises Invalid_argument
if
iis not a valid position ins. -
since 4.05
valrindex_from : ``bytes->``int->``char->int
rindex_from s i c returns the index of the last occurrence of byte c
in s before position i+1. rindex s c is equivalent to
rindex_from s (length s - 1) c.
-
raises Invalid_argument
if
i+1is not a valid position ins. -
raises Not_found
if
cdoes not occur insbefore positioni+1.
valrindex_from_opt : ``bytes->``int->``char->``int option
rindex_from_opt s i c returns the index of the last occurrence of byte
c in s before position i+1 or None if c does not occur in s
before position i+1. rindex_opt s c is equivalent to
rindex_from s (length s - 1) c.
-
raises Invalid_argument
if
i+1is not a valid position ins. -
since 4.05
valcontains : ``bytes->``char->bool
contains s c tests if byte c appears in s.
valcontains_from : ``bytes->``int->``char->bool
contains_from s start c tests if byte c appears in s after
position start. contains s c is equivalent to contains_from s 0 c.
-
raises Invalid_argument
if
startis not a valid position ins.
valrcontains_from : ``bytes->``int->``char->bool
rcontains_from s stop c tests if byte c appears in s before
position stop+1.
-
raises Invalid_argument
if
stop < 0orstop+1is not a valid position ins.
valuppercase : ``bytes->bytes
Return a copy of the argument, with all lowercase letters translated to uppercase, including accented letters of the ISO Latin-1 (8859-1) character set.
-
deprecated
Functions operating on Latin-1 character set are deprecated.
vallowercase : ``bytes->bytes
Return a copy of the argument, with all uppercase letters translated to lowercase, including accented letters of the ISO Latin-1 (8859-1) character set.
-
deprecated
Functions operating on Latin-1 character set are deprecated.
valcapitalize : ``bytes->bytes
Return a copy of the argument, with the first character set to uppercase, using the ISO Latin-1 (8859-1) character set.
-
deprecated
Functions operating on Latin-1 character set are deprecated.
valuncapitalize : ``bytes->bytes
Return a copy of the argument, with the first character set to lowercase, using the ISO Latin-1 (8859-1) character set.
-
deprecated
Functions operating on Latin-1 character set are deprecated.
valuppercase_ascii : ``bytes->bytes
Return a copy of the argument, with all lowercase letters translated to uppercase, using the US-ASCII character set.
- since 4.05.0
vallowercase_ascii : ``bytes->bytes
Return a copy of the argument, with all uppercase letters translated to lowercase, using the US-ASCII character set.
- since 4.05.0
valcapitalize_ascii : ``bytes->bytes
Return a copy of the argument, with the first character set to uppercase, using the US-ASCII character set.
- since 4.05.0
valuncapitalize_ascii : ``bytes->bytes
Return a copy of the argument, with the first character set to lowercase, using the US-ASCII character set.
- since 4.05.0
typet`` = bytes
An alias for the type of byte sequences.
The comparison function for byte sequences, with the same specification
as Stdlib.compare. Along with the type t,
this function compare allows the module Bytes to be passed as
argument to the functors Set.Make and
Map.Make.
valstarts_with : ``prefix:bytes->``bytes->bool
starts_with ``~``prefix s is true if and only if s starts with
prefix.
- since 4.13.0
valends_with : ``suffix:bytes->``bytes->bool
ends_with suffix s is true if and only if s ends with suffix.
- since 4.13.0
Unsafe conversions (for advanced users)
This section describes unsafe, low-level conversion functions between
bytes and string. They do not copy the internal data; used
improperly, they can break the immutability invariant on strings
provided by the -safe-string option. They are available for expert
library authors, but for most purposes you should use the always-correct
to_string and of_string instead.
valunsafe_to_string : ``bytes->string
Unsafely convert a byte sequence into a string.
To reason about the use of unsafe_to_string, it is convenient to
consider an "ownership" discipline. A piece of code that manipulates
some data "owns" it; there are several disjoint ownership modes,
including:
- Unique ownership: the data may be accessed and mutated
- Shared ownership: the data has several owners, that may only access it, not mutate it.
Unique ownership is linear: passing the data to another piece of code means giving up ownership (we cannot write the data again). A unique owner may decide to make the data shared (giving up mutation rights on it), but shared data may not become uniquely-owned again.
unsafe_to_string s can only be used when the caller owns the byte
sequence s -- either uniquely or as shared immutable data. The caller
gives up ownership of s, and gains ownership of the returned string.
There are two valid use-cases that respect this ownership discipline:
1. Creating a string by initializing and mutating a byte sequence that is never changed after initialization is performed.
let string_init len f : string =
let s = Bytes.create len in
for i = 0 to len - 1 do Bytes.set s i (f i) done;
Bytes.unsafe_to_string sThis function is safe because the byte sequence s will never be
accessed or mutated after unsafe_to_string is called. The
string_init code gives up ownership of s, and returns the ownership
of the resulting string to its caller.
Note that it would be unsafe if s was passed as an additional
parameter to the function f as it could escape this way and be mutated
in the future -- string_init would give up ownership of s to pass it
to f, and could not call unsafe_to_string safely.
We have provided the String.init,
String.map and
String.mapi functions to cover most
cases of building new strings. You should prefer those over to_string
or unsafe_to_string whenever applicable.
2. Temporarily giving ownership of a byte sequence to a function that expects a uniquely owned string and returns ownership back, so that we can mutate the sequence again after the call ended.
let bytes_length (s : bytes) =
String.length (Bytes.unsafe_to_string s)In this use-case, we do not promise that s will never be mutated after
the call to bytes_length s. The
String.length function temporarily
borrows unique ownership of the byte sequence (and sees it as a
string), but returns this ownership back to the caller, which may
assume that s is still a valid byte sequence after the call. Note that
this is only correct because we know that
String.length does not capture its
argument -- it could escape by a side-channel such as a memoization
combinator.
The caller may not mutate s while the string is borrowed (it has
temporarily given up ownership). This affects concurrent programs, but
also higher-order functions: if
String.length returned a closure to
be called later, s should not be mutated until this closure is fully
applied and returns ownership.
valunsafe_of_string : ``string->bytes
Unsafely convert a shared string to a byte sequence that should not be mutated.
The same ownership discipline that makes unsafe_to_string correct
applies to unsafe_of_string: you may use it if you were the owner of
the string value, and you will own the return bytes in the same
mode.
In practice, unique ownership of string values is extremely difficult to reason about correctly. You should always assume strings are shared, never uniquely owned.
For example, string literals are implicitly shared by the compiler, so you never uniquely own them.
let incorrect = Bytes.unsafe_of_string "hello"
let s = Bytes.of_string "hello"The first declaration is incorrect, because the string literal "hello"
could be shared by the compiler with other parts of the program, and
mutating incorrect is a bug. You must always use the second version,
which performs a copy and is thus correct.
Assuming unique ownership of strings that are not string literals, but
are (partly) built from string literals, is also incorrect. For example,
mutating unsafe_of_string ("foo" ^ s) could mutate the shared string
"foo" -- assuming a rope-like representation of strings. More
generally, functions operating on strings will assume shared ownership,
they do not preserve unique ownership. It is thus incorrect to assume
unique ownership of the result of unsafe_of_string.
The only case we have reasonable confidence is safe is if the produced
bytes is shared -- used as an immutable byte sequence. This is
possibly useful for incremental migration of low-level programs that
manipulate immutable sequences of bytes (for example
Marshal.from_bytes) and
previously used the string type for this purpose.
valsplit_on_char : ``sep:char->``bytes->``bytes list
split_on_char sep s returns the list of all (possibly empty)
subsequences of s that are delimited by the sep character.
The function's output is specified by the following invariants:
-
The list is not empty.
-
Concatenating its elements using
sepas a separator returns a byte sequence equal to the input (Bytes.concat (Bytes.make 1 sep) (Bytes.split_on_char sep s) = s). -
No byte sequence in the result contains the
sepcharacter. -
since 4.13.0
Iterators
Iterate on the string, in increasing index order. Modifications of the string during iteration will be reflected in the sequence.
- since 4.07
Iterate on the string, in increasing order, yielding indices along chars
- since 4.07
UTF codecs and validations
- since 4.14
UTF-8
valget_utf_8_uchar :t->``int->Uchar.utf_decode
get_utf_8_uchar b i decodes an UTF-8 character at index i in b.
set_utf_8_uchar b i u UTF-8 encodes u at index i in b and
returns the number of bytes n that were written starting at i. If
n is 0 there was not enough space to encode u at i and b was
left untouched. Otherwise a new character can be encoded at i + n.
valis_valid_utf_8 :t->bool
is_valid_utf_8 b is true if and only if b contains valid UTF-8
data.
UTF-16BE
valget_utf_16be_uchar :t->``int->Uchar.utf_decode
get_utf_16be_uchar b i decodes an UTF-16BE character at index i in
b.
set_utf_16be_uchar b i u UTF-16BE encodes u at index i in b and
returns the number of bytes n that were written starting at i. If
n is 0 there was not enough space to encode u at i and b was
left untouched. Otherwise a new character can be encoded at i + n.
valis_valid_utf_16be :t->bool
is_valid_utf_16be b is true if and only if b contains valid
UTF-16BE data.
UTF-16LE
valget_utf_16le_uchar :t->``int->Uchar.utf_decode
get_utf_16le_uchar b i decodes an UTF-16LE character at index i in
b.
set_utf_16le_uchar b i u UTF-16LE encodes u at index i in b and
returns the number of bytes n that were written starting at i. If
n is 0 there was not enough space to encode u at i and b was
left untouched. Otherwise a new character can be encoded at i + n.
valis_valid_utf_16le :t->bool
is_valid_utf_16le b is true if and only if b contains valid
UTF-16LE data.
Binary encoding/decoding of integers
The functions in this section binary encode and decode integers to and from byte sequences.
All following functions raise Invalid_argument if the space needed at
index i to decode or encode the integer is not available.
Little-endian (resp. big-endian) encoding means that least (resp. most)
significant bytes are stored first. Big-endian is also known as network
byte order. Native-endian encoding is either little-endian or big-endian
depending on Sys.big_endian.
32-bit and 64-bit integers are represented by the int32 and int64
types, which can be interpreted either as signed or unsigned numbers.
8-bit and 16-bit integers are represented by the int type, which has
more bits than the binary encoding. These extra bits are handled as
follows:
- Functions that decode signed (resp. unsigned) 8-bit or 16-bit integers
represented by
intvalues sign-extend (resp. zero-extend) their result. - Functions that encode 8-bit or 16-bit integers represented by
intvalues truncate their input to their least significant bytes.
valget_uint8 : ``bytes->``int->int
get_uint8 b i is b's unsigned 8-bit integer starting at byte index
i.
- since 4.08
valget_int8 : ``bytes->``int->int
get_int8 b i is b's signed 8-bit integer starting at byte index i.
- since 4.08
valget_uint16_ne : ``bytes->``int->int
get_uint16_ne b i is b's native-endian unsigned 16-bit integer
starting at byte index i.
- since 4.08
valget_uint16_be : ``bytes->``int->int
get_uint16_be b i is b's big-endian unsigned 16-bit integer starting
at byte index i.
- since 4.08
valget_uint16_le : ``bytes->``int->int
get_uint16_le b i is b's little-endian unsigned 16-bit integer
starting at byte index i.
- since 4.08
valget_int16_ne : ``bytes->``int->int
get_int16_ne b i is b's native-endian signed 16-bit integer starting
at byte index i.
- since 4.08
valget_int16_be : ``bytes->``int->int
get_int16_be b i is b's big-endian signed 16-bit integer starting at
byte index i.
- since 4.08
valget_int16_le : ``bytes->``int->int
get_int16_le b i is b's little-endian signed 16-bit integer starting
at byte index i.
- since 4.08
valget_int32_ne : ``bytes->``int->int32
get_int32_ne b i is b's native-endian 32-bit integer starting at
byte index i.
- since 4.08
valget_int32_be : ``bytes->``int->int32
get_int32_be b i is b's big-endian 32-bit integer starting at byte
index i.
- since 4.08
valget_int32_le : ``bytes->``int->int32
get_int32_le b i is b's little-endian 32-bit integer starting at
byte index i.
- since 4.08
valget_int64_ne : ``bytes->``int->int64
get_int64_ne b i is b's native-endian 64-bit integer starting at
byte index i.
- since 4.08
valget_int64_be : ``bytes->``int->int64
get_int64_be b i is b's big-endian 64-bit integer starting at byte
index i.
- since 4.08
valget_int64_le : ``bytes->``int->int64
get_int64_le b i is b's little-endian 64-bit integer starting at
byte index i.
- since 4.08
valset_uint8 : ``bytes->``int->``int->unit
set_uint8 b i v sets b's unsigned 8-bit integer starting at byte
index i to v.
- since 4.08
valset_int8 : ``bytes->``int->``int->unit
set_int8 b i v sets b's signed 8-bit integer starting at byte index
i to v.
- since 4.08
valset_uint16_ne : ``bytes->``int->``int->unit
set_uint16_ne b i v sets b's native-endian unsigned 16-bit integer
starting at byte index i to v.
- since 4.08
valset_uint16_be : ``bytes->``int->``int->unit
set_uint16_be b i v sets b's big-endian unsigned 16-bit integer
starting at byte index i to v.
- since 4.08
valset_uint16_le : ``bytes->``int->``int->unit
set_uint16_le b i v sets b's little-endian unsigned 16-bit integer
starting at byte index i to v.
- since 4.08
valset_int16_ne : ``bytes->``int->``int->unit
set_int16_ne b i v sets b's native-endian signed 16-bit integer
starting at byte index i to v.
- since 4.08
valset_int16_be : ``bytes->``int->``int->unit
set_int16_be b i v sets b's big-endian signed 16-bit integer
starting at byte index i to v.
- since 4.08
valset_int16_le : ``bytes->``int->``int->unit
set_int16_le b i v sets b's little-endian signed 16-bit integer
starting at byte index i to v.
- since 4.08
valset_int32_ne : ``bytes->``int->``int32->unit
set_int32_ne b i v sets b's native-endian 32-bit integer starting at
byte index i to v.
- since 4.08
valset_int32_be : ``bytes->``int->``int32->unit
set_int32_be b i v sets b's big-endian 32-bit integer starting at
byte index i to v.
- since 4.08
valset_int32_le : ``bytes->``int->``int32->unit
set_int32_le b i v sets b's little-endian 32-bit integer starting at
byte index i to v.
- since 4.08
valset_int64_ne : ``bytes->``int->``int64->unit
set_int64_ne b i v sets b's native-endian 64-bit integer starting at
byte index i to v.
- since 4.08
valset_int64_be : ``bytes->``int->``int64->unit
set_int64_be b i v sets b's big-endian 64-bit integer starting at
byte index i to v.
- since 4.08
valset_int64_le : ``bytes->``int->``int64->unit
set_int64_le b i v sets b's little-endian 64-bit integer starting at
byte index i to v.
- since 4.08
