module Bytes: BytesLabelsval length : bytes -> intReturn the length (number of bytes) of the argument.
val get : bytes -> int -> charget s n returns the byte at index n in argument s.
Invalid_argument if n is not a valid index in s.val set : bytes -> int -> char -> unitset s n c modifies s in place, replacing the byte at index n
with c.
Invalid_argument if n is not a valid index in s.val create : int -> bytescreate n returns a new byte sequence of length n. The
sequence is uninitialized and contains arbitrary bytes.
Invalid_argument if n < 0 or n > Sys.max_string_length.val make : int -> char -> bytesmake n c returns a new byte sequence of length n, filled with
the byte c.
Invalid_argument if n < 0 or n > Sys.max_string_length.val init : int -> f:(int -> char) -> bytesinit n f returns a fresh byte sequence of length n,
with character i initialized to the result of f i.
Invalid_argument if n < 0 or n > Sys.max_string_length.val empty : bytesA byte sequence of size 0.
val copy : bytes -> bytesReturn a new byte sequence that contains the same bytes as the argument.
val of_string : string -> bytesReturn a new byte sequence that contains the same bytes as the given string.
val to_string : bytes -> stringReturn a new string that contains the same bytes as the given byte sequence.
val sub : bytes -> pos:int -> len:int -> bytessub s start len returns a new byte sequence of length len,
containing the subsequence of s that starts at position start
and has length len.
Invalid_argument if start and len do not designate a
valid range of s.val sub_string : bytes -> pos:int -> len:int -> stringSame as sub but return a string instead of a byte sequence.
val extend : bytes -> left:int -> right:int -> bytesextend 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.
Invalid_argument if the result length is negative or
longer than Sys.max_string_length bytes.val fill : bytes -> pos:int -> len:int -> char -> unitfill s start len c modifies s in place, replacing len
characters with c, starting at start.
Invalid_argument if start and len do not designate a
valid range of s.val blit : src:bytes -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unitblit src srcoff dst dstoff len copies len bytes from sequence
src, starting at index srcoff, to sequence dst, starting at
index dstoff. It works correctly even if src and dst are the
same byte sequence, and the source and destination intervals
overlap.
Invalid_argument if srcoff and len do not
designate a valid range of src, or if dstoff and len
do not designate a valid range of dst.val blit_string : src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unitblit src srcoff dst dstoff len copies len bytes from string
src, starting at index srcoff, to byte sequence dst,
starting at index dstoff.
Invalid_argument if srcoff and len do not
designate a valid range of src, or if dstoff and len
do not designate a valid range of dst.val concat : sep:bytes -> bytes list -> bytesconcat 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.
val cat : bytes -> bytes -> bytescat s1 s2 concatenates s1 and s2 and returns the result
as new byte sequence.
Invalid_argument if the result is longer than
Sys.max_string_length bytes.val iter : f:(char -> unit) -> bytes -> unititer 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)); ()
val iteri : f:(int -> char -> unit) -> bytes -> unitSame as Bytes.iter, but the function is applied to the index of
the byte as first argument and the byte itself as second
argument.
val map : f:(char -> char) -> bytes -> bytesmap f s applies function f in turn to all the bytes of s and
stores the resulting bytes in a new sequence that is returned as
the result.
val mapi : f:(int -> char -> char) -> bytes -> bytesmapi 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.
val trim : bytes -> bytesReturn a copy of the argument, without leading and trailing
whitespace. The bytes regarded as whitespace are the ASCII
characters ' ', '\012', '\n', '\r', and '\t'.
val escaped : bytes -> bytesReturn a copy of the argument, with special characters represented by escape sequences, following the lexical conventions of OCaml.
val index : bytes -> char -> intindex s c returns the index of the first occurrence of byte c
in s.
Not_found if c does not occur in s.val index_opt : bytes -> char -> int optionindex_opt s c returns the index of the first occurrence of byte c
in s or None if c does not occur in s.
val rindex : bytes -> char -> intrindex s c returns the index of the last occurrence of byte c
in s.
Not_found if c does not occur in s.val rindex_opt : bytes -> char -> int optionrindex_opt s c returns the index of the last occurrence of byte c
in s or None if c does not occur in s.
val index_from : bytes -> int -> char -> intindex_from s i c returns the index of the first occurrence of
byte c in s after position i. Bytes.index s c is
equivalent to Bytes.index_from s 0 c.
Invalid_argument if i is not a valid position in s.Not_found if c does not occur in s after position i.val index_from_opt : bytes -> int -> char -> int optionindex_from _opts 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.
Bytes.index_opt s c is equivalent to Bytes.index_from_opt s 0 c.
Invalid_argument if i is not a valid position in s.val rindex_from : bytes -> int -> char -> intrindex_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 (Bytes.length s - 1) c.
Invalid_argument if i+1 is not a valid position in s.Not_found if c does not occur in s before position i+1.val rindex_from_opt : bytes -> int -> char -> int optionrindex_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 (Bytes.length s - 1) c.
Invalid_argument if i+1 is not a valid position in s.val contains : bytes -> char -> boolcontains s c tests if byte c appears in s.
val contains_from : bytes -> int -> char -> boolcontains_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
Invalid_argument if start is not a valid position in s.val rcontains_from : bytes -> int -> char -> boolrcontains_from s stop c tests if byte c appears in s before
position stop+1.
Invalid_argument if stop < 0 or stop+1 is not a valid
position in s.val uppercase : bytes -> bytesReturn a copy of the argument, with all lowercase letters translated to uppercase, including accented letters of the ISO Latin-1 (8859-1) character set.
val lowercase : bytes -> bytesReturn a copy of the argument, with all uppercase letters translated to lowercase, including accented letters of the ISO Latin-1 (8859-1) character set.
val capitalize : bytes -> bytesReturn a copy of the argument, with the first character set to uppercase, using the ISO Latin-1 (8859-1) character set..
val uncapitalize : bytes -> bytesReturn a copy of the argument, with the first character set to lowercase, using the ISO Latin-1 (8859-1) character set..
val uppercase_ascii : bytes -> bytesReturn a copy of the argument, with all lowercase letters translated to uppercase, using the US-ASCII character set.
val lowercase_ascii : bytes -> bytesReturn a copy of the argument, with all uppercase letters translated to lowercase, using the US-ASCII character set.
val capitalize_ascii : bytes -> bytesReturn a copy of the argument, with the first character set to uppercase, using the US-ASCII character set.
val uncapitalize_ascii : bytes -> bytesReturn a copy of the argument, with the first character set to lowercase, using the US-ASCII character set.
typet =bytes
An alias for the type of byte sequences.
val compare : t -> t -> intval equal : t -> t -> boolThe equality function for byte sequences.
val to_seq : t -> char Seq.tIterate on the string, in increasing index order. Modifications of the string during iteration will be reflected in the iterator.
val to_seqi : t -> (int * char) Seq.tIterate on the string, in increasing order, yielding indices along chars
val of_seq : char Seq.t -> tCreate a string from the generator
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:
int values sign-extend
(resp. zero-extend) their result.int values truncate their input to their least significant
bytes.val get_uint8 : bytes -> int -> intget_uint8 b i is b's unsigned 8-bit integer starting at byte index i.
val get_int8 : bytes -> int -> intget_int8 b i is b's signed 8-bit integer starting at byte index i.
val get_uint16_ne : bytes -> int -> intget_uint16_ne b i is b's native-endian unsigned 16-bit integer
starting at byte index i.
val get_uint16_be : bytes -> int -> intget_uint16_be b i is b's big-endian unsigned 16-bit integer
starting at byte index i.
val get_uint16_le : bytes -> int -> intget_uint16_le b i is b's little-endian unsigned 16-bit integer
starting at byte index i.
val get_int16_ne : bytes -> int -> intget_int16_ne b i is b's native-endian signed 16-bit integer
starting at byte index i.
val get_int16_be : bytes -> int -> intget_int16_be b i is b's big-endian signed 16-bit integer
starting at byte index i.
val get_int16_le : bytes -> int -> intget_int16_le b i is b's little-endian signed 16-bit integer
starting at byte index i.
val get_int32_ne : bytes -> int -> int32get_int32_ne b i is b's native-endian 32-bit integer
starting at byte index i.
val get_int32_be : bytes -> int -> int32get_int32_be b i is b's big-endian 32-bit integer
starting at byte index i.
val get_int32_le : bytes -> int -> int32get_int32_le b i is b's little-endian 32-bit integer
starting at byte index i.
val get_int64_ne : bytes -> int -> int64get_int64_ne b i is b's native-endian 64-bit integer
starting at byte index i.
val get_int64_be : bytes -> int -> int64get_int64_be b i is b's big-endian 64-bit integer
starting at byte index i.
val get_int64_le : bytes -> int -> int64get_int64_le b i is b's little-endian 64-bit integer
starting at byte index i.
val set_uint8 : bytes -> int -> int -> unitset_uint8 b i v sets b's unsigned 8-bit integer starting at byte index
i to v.
val set_int8 : bytes -> int -> int -> unitset_int8 b i v sets b's signed 8-bit integer starting at byte index
i to v.
val set_uint16_ne : bytes -> int -> int -> unitset_uint16_ne b i v sets b's native-endian unsigned 16-bit integer
starting at byte index i to v.
val set_uint16_be : bytes -> int -> int -> unitset_uint16_be b i v sets b's big-endian unsigned 16-bit integer
starting at byte index i to v.
val set_uint16_le : bytes -> int -> int -> unitset_uint16_le b i v sets b's little-endian unsigned 16-bit integer
starting at byte index i to v.
val set_int16_ne : bytes -> int -> int -> unitset_int16_ne b i v sets b's native-endian signed 16-bit integer
starting at byte index i to v.
val set_int16_be : bytes -> int -> int -> unitset_int16_be b i v sets b's big-endian signed 16-bit integer
starting at byte index i to v.
val set_int16_le : bytes -> int -> int -> unitset_int16_le b i v sets b's little-endian signed 16-bit integer
starting at byte index i to v.
val set_int32_ne : bytes -> int -> int32 -> unitset_int32_ne b i v sets b's native-endian 32-bit integer
starting at byte index i to v.
val set_int32_be : bytes -> int -> int32 -> unitset_int32_be b i v sets b's big-endian 32-bit integer
starting at byte index i to v.
val set_int32_le : bytes -> int -> int32 -> unitset_int32_le b i v sets b's little-endian 32-bit integer
starting at byte index i to v.
val set_int64_ne : bytes -> int -> int64 -> unitset_int64_ne b i v sets b's native-endian 64-bit integer
starting at byte index i to v.
val set_int64_be : bytes -> int -> int64 -> unitset_int64_be b i v sets b's big-endian 64-bit integer
starting at byte index i to v.
val set_int64_le : bytes -> int -> int64 -> unitset_int64_le b i v sets b's little-endian 64-bit integer
starting at byte index i to v.