Type of bigstrings

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

create length

• parameter max_mem_waiting_gc

  default = 256 M in OCaml <= 3.12, 1 G otherwise. As the total allocation of calls to create approach max_mem_waiting_gc_in_bytes, the pressure in the garbage collector to be more agressive will increase.

• returns

  a new bigstring having length. Content is undefined.

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.

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

set t pos sets the character at pos

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).

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.

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

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