Module Bigstringaf

create n returns a bigstring of length n

empty is the empty bigstring. It has length 0 and you can't really do much with it, but it's a good placeholder that only needs to be allocated once.

of_string ~off ~len s returns a bigstring of length len that contains the contents of string from the range [off, len).

copy t ~off ~len allocates a new bigstring of length len and copies the bytes from t copied into it starting from off.

sub t ~off ~len does not allocate a bigstring, but instead returns a new view into t starting at off, and with length len.

Note that this does not allocate a new buffer, but instead shares the buffer of t with the newly-returned bigstring.

length t is the length of the bigstring, in bytes.

substring t ~off ~len returns a string of length len containing the bytes of t starting at off.

to_string t is equivalent to substring t ~off:0 ~len:(length t)

get t i returns the character at offset i in t.

set t i c sets the character at offset i in t to be c

get_int16_le t i returns the two bytes in t starting at offset i, interpreted as an unsigned integer.

get_int16_sign_extended_le t i returns the two bytes in t starting at offset i, interpreted as a signed integer and performing sign extension to the native word size before returning the result.

set_int16_le t i v sets the two bytes in t starting at offset i to the value v.

get_int32_le t i returns the four bytes in t starting at offset i.

set_int32_le t i v sets the four bytes in t starting at offset i to the value v.

get_int64_le t i returns the eight bytes in t starting at offset i.

set_int64_le t i v sets the eight bytes in t starting at offset i to the value v.

get_int16_be t i returns the two bytes in t starting at offset i, interpreted as an unsigned integer.

get_int16_sign_extended_be t i returns the two bytes in t starting at offset i, interpreted as a signed integer and performing sign extension to the native word size before returning the result.

set_int16_be t i v sets the two bytes in t starting at offset off to the value v.

get_int32_be t i returns the four bytes in t starting at offset i.

set_int32_be t i v sets the four bytes in t starting at offset i to the value v.

get_int64_be t i returns the eight bytes in t starting at offset i.

set_int64_be t i v sets the eight bytes in t starting at offset i to the value v.

unsafe_get t i is like get except no bounds checking is performed.

unsafe_set t i c is like set except no bounds checking is performed.

unsafe_get_int16_le t i is like get_int16_le except no bounds checking is performed.

unsafe_get_int16_be t i is like get_int16_be except no bounds checking is performed.

unsafe_get_int16_sign_extended_le t i is like get_int16_sign_extended_le except no bounds checking is performed.

unsafe_get_int16_sign_extended_be t i is like get_int16_sign_extended_be except no bounds checking is performed.

unsafe_set_int16_le t i v is like set_int16_le except no bounds checking is performed.

unsafe_set_int16_be t i v is like set_int16_be except no bounds checking is performed.

unsafe_get_int32_le t i is like get_int32_le except no bounds checking is performed.

unsafe_get_int32_be t i is like get_int32_be except no bounds checking is performed.

unsafe_set_int32_le t i v is like set_int32_le except no bounds checking is performed.

unsafe_set_int32_be t i v is like set_int32_be except no bounds checking is performed.

unsafe_get_int64_le t i is like get_int64_le except no bounds checking is performed.

unsafe_get_int64_be t i is like get_int64_be except no bounds checking is performed.

unsafe_set_int64_le t i v is like set_int64_le except no bounds checking is performed.

unsafe_set_int64_be t i v is like set_int64_be except no bounds checking is performed.