Types and exceptions
Type of bigstrings
val compare : t -> t -> Base.Int.tval sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.ttype t_frozen = tType of bigstrings which support hashing. Note that mutation invalidates previous hashes.
val compare_t_frozen : t_frozen -> t_frozen -> Base.Int.tval hash_fold_t_frozen : Base.Hash.state -> t_frozen -> Base.Hash.stateval hash_t_frozen : t_frozen -> Base.Hash.hash_valueval sexp_of_t_frozen : t_frozen -> Ppx_sexp_conv_lib.Sexp.tinclude module type of Base_bigstring with type t := t and type t_frozen := t_frozen
Types and exceptions
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> tval sexp_of_t : t -> Sexplib0.Sexp.tval hash_fold_t_frozen : Base.Hash.state -> t_frozen -> Base.Hash.stateval hash_t_frozen : t_frozen -> Base.Hash.hash_valueval sexp_of_t_frozen : t_frozen -> Ppx_sexp_conv_lib.Sexp.tval t_frozen_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> t_frozeninclude Base.Equal.S with type t := t
val equal : t Base.Equal.equalCreation and string conversion
create length
- parameter max_mem_waiting_gc
default = 256 M in OCaml <= 3.12, 1 G otherwise. As the total allocation of calls to
createapproachmax_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.
val of_string : ?pos:Base.int -> ?len:Base.int -> Base.string -> tof_string ?pos ?len str
- returns
a new bigstring that is equivalent to the substring of length
leninstrstarting at positionpos.
- parameter pos
default = 0
- parameter len
default =
String.length str - pos
val of_bytes : ?pos:Base.int -> ?len:Base.int -> Base.bytes -> tof_bytes ?pos ?len str
- returns
a new bigstring that is equivalent to the subbytes of length
leninstrstarting at positionpos.
- parameter pos
default = 0
- parameter len
default =
Bytes.length str - pos
val to_string : ?pos:Base.int -> ?len:Base.int -> t -> Base.stringto_string ?pos ?len bstr
- returns
a new string that is equivalent to the substring of length
leninbstrstarting at positionpos.
- parameter pos
default = 0
- parameter len
default =
length bstr - pos
- raises Invalid_argument
if the string would exceed runtime limits.
val to_bytes : ?pos:Base.int -> ?len:Base.int -> t -> Base.bytesto_bytes ?pos ?len bstr
- returns
a new byte sequence that is equivalent to the substring of length
leninbstrstarting at positionpos.
- 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.
Checking
val check_args : loc:Base.string -> pos:Base.int -> len:Base.int -> t -> Base.unitcheck_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
locto indicate the calling context.
val get_opt_len : t -> pos:Base.int -> Base.int Base.option -> Base.intget_opt_len bstr ~pos opt_len
- returns
the length of a subbigstring in
bstrstarting at positionposand given optional lengthopt_len. This function does not check the validity of its arguments. Usecheck_argsfor that purpose.
Accessors
Blitting
include Base.Blit.S with type t := t
module To_string : sig ... endmodule From_string : Base.Blit.S_distinct with type src := Base.string with type dst := tmodule To_bytes : Base.Blit.S_distinct with type src := t with type dst := Base.bytesmodule From_bytes : Base.Blit.S_distinct with type src := Base.bytes with type dst := tmemset 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.
Search
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.
Accessors for parsing binary values, analogous to Binary_packing
16-bit methods
32-bit methods
64-bit signed values
64-bit unsigned values
32-bit methods with full precision
val get_int32_t_le : t -> pos:Base.int -> Base.Int32.tval get_int32_t_be : t -> pos:Base.int -> Base.Int32.tval set_int32_t_le : t -> pos:Base.int -> Base.Int32.t -> Base.unitval set_int32_t_be : t -> pos:Base.int -> Base.Int32.t -> Base.unitval unsafe_get_int32_t_le : t -> pos:Base.int -> Base.Int32.tval unsafe_get_int32_t_be : t -> pos:Base.int -> Base.Int32.tval unsafe_set_int32_t_le : t -> pos:Base.int -> Base.Int32.t -> Base.unitval unsafe_set_int32_t_be : t -> pos:Base.int -> Base.Int32.t -> Base.unit64-bit methods with full precision
val get_int64_t_le : t -> pos:Base.int -> Base.Int64.tval get_int64_t_be : t -> pos:Base.int -> Base.Int64.tval set_int64_t_le : t -> pos:Base.int -> Base.Int64.t -> Base.unitval set_int64_t_be : t -> pos:Base.int -> Base.Int64.t -> Base.unitval unsafe_get_int64_t_le : t -> pos:Base.int -> Base.Int64.tval unsafe_get_int64_t_be : t -> pos:Base.int -> Base.Int64.tval unsafe_set_int64_t_le : t -> pos:Base.int -> Base.Int64.t -> Base.unitval unsafe_set_int64_t_be : t -> pos:Base.int -> Base.Int64.t -> Base.unitmodule Private : sig ... endCreation and string conversion
val create : ?max_mem_waiting_gc:Byte_units.t -> Base.Int.t -> tcreate length
- parameter max_mem_waiting_gc
default = 256 M in OCaml <= 3.12, 1 G otherwise. As the total allocation of calls to
createapproachmax_mem_waiting_gc, the pressure in the garbage collector to be more agressive will increase.
- returns
a new bigstring having
length. Content is undefined.
sub_shared ?pos ?len bstr
- returns
the sub-bigstring in
bstrthat starts at positionposand has lengthlen. The sub-bigstring shares the same memory region, i.e. modifying it will modify the original bigstring. Holding on to the sub-bigstring will also keep the (usually bigger) original one around.
- parameter pos
default = 0
- parameter len
default =
Bigstring.length bstr - pos
Reading/writing bin-prot
val write_bin_prot : t -> ?pos:Base.Int.t -> 'a Bin_prot.Type_class.writer -> 'a -> Base.Int.twrite_bin_prot t writer a writes a to t starting at pos, and returns the index in t immediately after the last byte written. It raises if pos < 0 or if a doesn't fit in t.
val read_bin_prot : t -> ?pos:Base.Int.t -> ?len:Base.Int.t -> 'a Bin_prot.Type_class.reader -> ('a * Base.Int.t) Or_error.tThe read_bin_prot* functions read from the region of t starting at pos of length len. They return the index in t immediately after the last byte read. They raise if pos and len don't describe a region of t.
val read_bin_prot_verbose_errors : t -> ?pos:Base.Int.t -> ?len:Base.Int.t -> 'a Bin_prot.Type_class.reader -> [ `Invalid_data of Error.t | `Not_enough_data | `Ok of 'a * Base.Int.t ]Destruction
val unsafe_destroy : t -> Base.Unit.tunsafe_destroy bstr destroys the bigstring by deallocating its associated data or, if memory-mapped, unmapping the corresponding file, and setting all dimensions to zero. This effectively frees the associated memory or address-space resources instantaneously. This feature helps working around a bug in the current OCaml runtime, which does not correctly estimate how aggressively to reclaim such resources.
This operation is safe unless you have passed the bigstring to another thread that is performing operations on it at the same time. Access to the bigstring after this operation will yield array bounds exceptions.
- raises Failure
if the bigstring has already been deallocated (or deemed "external", which is treated equivalently), or if it has proxies, i.e. other bigstrings referring to the same data.
val unsafe_destroy_and_resize : t -> len:Base.Int.t -> tunsafe_destroy_and_resize bstr ~len reallocates the memory backing bstr and returns a new bigstring that starts at position 0 and has length len. If len is greater than length bstr then the newly allocated memory will not be initialized.
Similar to unsafe_destroy, this operation is safe unless you have passed the bigstring to another thread that is performing operations on it at the same time. Access to bstr after this operation will yield array bounds exceptions.
- raises Failure
if the bigstring has already been deallocated (or deemed "external", which is treated equivalently), if it is backed by a memory map, or if it has proxies, i.e. other bigstrings referring to the same data.
val get_tail_padded_fixed_string : padding:Base.Char.t -> t -> pos:Base.Int.t -> len:Base.Int.t -> Base.Unit.t -> Base.String.tSimilar to Binary_packing.unpack_tail_padded_fixed_string and .pack_tail_padded_fixed_string.
val set_tail_padded_fixed_string : padding:Base.Char.t -> t -> pos:Base.Int.t -> len:Base.Int.t -> Base.String.t -> Base.Unit.tval get_head_padded_fixed_string : padding:Base.Char.t -> t -> pos:Base.Int.t -> len:Base.Int.t -> Base.Unit.t -> Base.String.tval set_head_padded_fixed_string : padding:Base.Char.t -> t -> pos:Base.Int.t -> len:Base.Int.t -> Base.String.t -> Base.Unit.tmodule Unstable : sig ... endmodule Stable : sig ... end