Module Base_bigstringSource

Type of bigstrings

Type of bigstrings which support hashing. Note that mutation invalidates previous hashes.

create length

• returns

  a new bigstring having length. Content is undefined.

empty is a bigstring of length 0

init n ~f creates a bigstring t of length n, with t.{i} = f i.

of_string ?pos ?len str

• returns

  a new bigstring that is equivalent to the substring of length len in str starting at position pos.

• parameter pos

  default = 0

• parameter len

  default = String.length str - pos

of_bytes ?pos ?len str

• returns

  a new bigstring that is equivalent to the subbytes of length len in str starting at position pos.

• parameter pos

  default = 0

• parameter len

  default = Bytes.length str - pos

to_string ?pos ?len bstr

• returns

  a new string that is equivalent to the substring of length len in bstr starting at position pos.

• parameter pos

  default = 0

• parameter len

  default = length bstr - pos

• raises Invalid_argument

  if the string would exceed runtime limits.

to_bytes ?pos ?len bstr

• returns

  a new byte sequence that is equivalent to the substring of length len in bstr starting at position pos.

• parameter pos

  default = 0

• parameter len

  default = length bstr - pos

• raises Invalid_argument

  if the bytes would exceed runtime limits.

concat ?sep list returns the concatenation of list with sep in between each.

Like globalize, but does not copy the bigstring. Returns the input unchanged, as all bigstrings are allocated on the heap as custom blocks.

May be unsafe to hold on to the bigstring and access its storage if the source of the local value overwrites or deletes its storage later.

check_args ~loc ~pos ~len bstr checks the position and length arguments pos and len for bigstrings bstr.

• raises

  Invalid_argument if these arguments are illegal for the given bigstring using loc to indicate the calling context.

get_opt_len bstr ~pos opt_len

• returns

  the length of a subbigstring in bstr starting at position pos and given optional length opt_len. This function does not check the validity of its arguments. Use check_args for that purpose.

length bstr

• returns

  the length of bigstring bstr.

get t pos returns the character at pos

unsafe_get t pos returns the character at pos, without bounds checks.

set t pos sets the character at pos

unsafe_set t pos sets the character at pos, without bounds checks.

is_mmapped bstr

• returns

  whether the bigstring bstr is memory-mapped.

memset t ~pos ~len c fills t with c within the range [pos, pos + len).

unsafe_memset t ~pos ~len c fills t with c within the range [pos, pos + len), without bounds checks.

memcmp t1 ~pos1 t2 ~pos2 ~len is like compare t1 t2 except performs the comparison on the subregions of t1 and t2 defined by pos1, pos2, and len.

memcmp_bytes, for efficient memcmp between Bigstring and Bytes data.

memcmp_string, for efficient memcmp between Bigstring and string data.

Compares up to len characters of two (potentially null-terminated) strings beginning at pos1 and pos2 of their respective Bigstrings. This function starts comparing the first character of each string. If they are equal to each other, it continues with the following pairs until the characters differ, until a terminating null-character is reached, or until len characters match in both strings, whichever happens first.

unsafe_strncmp does no bounds checking.

find ?pos ?len char t returns Some i for the smallest i >= pos such that t.{i} = char, or None if there is no such i.

• parameter pos

  default = 0

• parameter len

  default = length bstr - pos

rfind ?pos ?len char t returns Some i for the largest i >= pos such that t.{i} = char, or None if there is no such i.

• parameter pos

  default = 0

• parameter len

  default = length bstr - pos

Same as find, but does no bounds checking, and returns a negative value instead of None if char is not found.

Same as rfind, but does no bounds checking, and returns a negative value instead of None if char is not found.

Search for the position of (a substring of) needle in (a substring of) haystack.

As unsafe_find for memmem.