Module Core_kernel.Bigstring
String type based on Bigarray
, for use in I/O and C-bindings.
Types and exceptions
type t
= (Core_kernel__.Import.char, Stdlib.Bigarray.int8_unsigned_elt, Stdlib.Bigarray.c_layout) Stdlib.Bigarray.Array1.t
Type of bigstrings
val compare : t -> t -> Core_kernel__.Import.int
val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
type t_frozen
= t
Type of bigstrings which support hashing. Note that mutation invalidates previous hashes.
val compare_t_frozen : t_frozen -> t_frozen -> Core_kernel__.Import.int
val hash_fold_t_frozen : Base.Hash.state -> t_frozen -> Base.Hash.state
val hash_t_frozen : t_frozen -> Base.Hash.hash_value
val sexp_of_t_frozen : t_frozen -> Ppx_sexp_conv_lib.Sexp.t
include module type of Base_bigstring with type Base_bigstring.t := t and type Base_bigstring.t_frozen := t_frozen
Types and exceptions
type t
= (Base.char, Stdlib.Bigarray.int8_unsigned_elt, Stdlib.Bigarray.c_layout) Stdlib.Bigarray.Array1.t
Type of bigstrings
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
type t_frozen
= t
Type of bigstrings which support hashing. Note that mutation invalidates previous hashes.
val compare_t_frozen : t_frozen -> t_frozen -> Base.int
val hash_fold_t_frozen : Base.Hash.state -> t_frozen -> Base.Hash.state
val hash_t_frozen : t_frozen -> Base.Hash.hash_value
val sexp_of_t_frozen : t_frozen -> Ppx_sexp_conv_lib.Sexp.t
val t_frozen_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> t_frozen
Creation and string conversion
val create : ?max_mem_waiting_gc_in_bytes:Base.int -> Base.int -> t
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
approachmax_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.
val init : Base.int -> f:(Base.int -> Base.char) -> t
init n ~f
creates a bigstringt
of lengthn
, witht.{i} = f i
.
val of_string : ?pos:Base.int -> ?len:Base.int -> Base.string -> t
of_string ?pos ?len str
- returns
a new bigstring that is equivalent to the substring of length
len
instr
starting at positionpos
.
- parameter pos
default = 0
- parameter len
default =
String.length str - pos
val of_bytes : ?pos:Base.int -> ?len:Base.int -> Base.bytes -> t
of_bytes ?pos ?len str
- returns
a new bigstring that is equivalent to the subbytes of length
len
instr
starting at positionpos
.
- parameter pos
default = 0
- parameter len
default =
Bytes.length str - pos
val to_string : ?pos:Base.int -> ?len:Base.int -> t -> Base.string
to_string ?pos ?len bstr
- returns
a new string that is equivalent to the substring of length
len
inbstr
starting 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.bytes
to_bytes ?pos ?len bstr
- returns
a new byte sequence that is equivalent to the substring of length
len
inbstr
starting at positionpos
.
- parameter pos
default = 0
- parameter len
default =
length bstr - pos
- raises Invalid_argument
if the bytes would exceed runtime limits.
Checking
val check_args : loc:Base.string -> pos:Base.int -> len:Base.int -> t -> Base.unit
check_args ~loc ~pos ~len bstr
checks the position and length argumentspos
andlen
for bigstringsbstr
.- raises
Invalid_argument if these arguments are illegal for the given bigstring using
loc
to indicate the calling context.
val get_opt_len : t -> pos:Base.int -> Base.int Base.option -> Base.int
get_opt_len bstr ~pos opt_len
- returns
the length of a subbigstring in
bstr
starting at positionpos
and given optional lengthopt_len
. This function does not check the validity of its arguments. Usecheck_args
for that purpose.
Accessors
Blitting
include Base.Blit.S with type t := t
val blit : (t, t) Base__.Blit_intf.blit
val blito : (t, t) Base__.Blit_intf.blito
val unsafe_blit : (t, t) Base__.Blit_intf.blit
val sub : (t, t) Base__.Blit_intf.sub
val subo : (t, t) Base__.Blit_intf.subo
module To_string = Base_bigstring.To_string
module From_string = Base_bigstring.From_string
module To_bytes = Base_bigstring.To_bytes
module From_bytes = Base_bigstring.From_bytes
Search
Accessors for parsing binary values, analogous to Binary_packing
These are in Bigstring
rather than a separate module because:
1. Existing Binary_packing
requires copies and does not work with bigstring
s. 2. The accessors rely on the implementation of bigstring
, and hence should change should the implementation of bigstring
move away from Bigarray
. 3. Bigstring
already has some external C functions, so it didn't require many changes to the jbuild
^_^.
In a departure from Binary_packing
, the naming conventions are chosen to be close to C99 stdint types, as it's a more standard description and it is somewhat useful in making compact macros for the implementations. The accessor names contain endian-ness to allow for branch-free implementations
<accessor> ::= <unsafe><operation><type><endian> <unsafe> ::= unsafe_ | '' <operation> ::= get_ | set_ <type> ::= int8 | uint8 | int16 | uint16 | int32 | uint32 | int64 | uint64 <endian> ::= _le | _be | ''
The unsafe_
prefix indicates that these functions do no bounds checking and silently truncate out-of-range numeric arguments.
val get_int8 : t -> pos:Base.int -> Base.int
val set_int8_exn : t -> pos:Base.int -> Base.int -> Base.unit
val get_uint8 : t -> pos:Base.int -> Base.int
val set_uint8_exn : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_get_int8 : t -> pos:Base.int -> Base.int
val unsafe_set_int8 : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_get_uint8 : t -> pos:Base.int -> Base.int
val unsafe_set_uint8 : t -> pos:Base.int -> Base.int -> Base.unit
16-bit methods
val get_int16_le : t -> pos:Base.int -> Base.int
val get_int16_be : t -> pos:Base.int -> Base.int
val set_int16_le_exn : t -> pos:Base.int -> Base.int -> Base.unit
val set_int16_be_exn : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_get_int16_le : t -> pos:Base.int -> Base.int
val unsafe_get_int16_be : t -> pos:Base.int -> Base.int
val unsafe_set_int16_le : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_set_int16_be : t -> pos:Base.int -> Base.int -> Base.unit
val get_uint16_le : t -> pos:Base.int -> Base.int
val get_uint16_be : t -> pos:Base.int -> Base.int
val set_uint16_le_exn : t -> pos:Base.int -> Base.int -> Base.unit
val set_uint16_be_exn : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_get_uint16_le : t -> pos:Base.int -> Base.int
val unsafe_get_uint16_be : t -> pos:Base.int -> Base.int
val unsafe_set_uint16_le : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_set_uint16_be : t -> pos:Base.int -> Base.int -> Base.unit
32-bit methods
val get_int32_le : t -> pos:Base.int -> Base.int
val get_int32_be : t -> pos:Base.int -> Base.int
val set_int32_le_exn : t -> pos:Base.int -> Base.int -> Base.unit
val set_int32_be_exn : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_get_int32_le : t -> pos:Base.int -> Base.int
val unsafe_get_int32_be : t -> pos:Base.int -> Base.int
val unsafe_set_int32_le : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_set_int32_be : t -> pos:Base.int -> Base.int -> Base.unit
val get_uint32_le : t -> pos:Base.int -> Base.int
val get_uint32_be : t -> pos:Base.int -> Base.int
val set_uint32_le_exn : t -> pos:Base.int -> Base.int -> Base.unit
val set_uint32_be_exn : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_get_uint32_le : t -> pos:Base.int -> Base.int
val unsafe_get_uint32_be : t -> pos:Base.int -> Base.int
val unsafe_set_uint32_le : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_set_uint32_be : t -> pos:Base.int -> Base.int -> Base.unit
64-bit signed values
val get_int64_le_exn : t -> pos:Base.int -> Base.int
val get_int64_be_exn : t -> pos:Base.int -> Base.int
val get_int64_le_trunc : t -> pos:Base.int -> Base.int
val get_int64_be_trunc : t -> pos:Base.int -> Base.int
val set_int64_le : t -> pos:Base.int -> Base.int -> Base.unit
val set_int64_be : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_get_int64_le_exn : t -> pos:Base.int -> Base.int
val unsafe_get_int64_be_exn : t -> pos:Base.int -> Base.int
val unsafe_get_int64_le_trunc : t -> pos:Base.int -> Base.int
val unsafe_get_int64_be_trunc : t -> pos:Base.int -> Base.int
val unsafe_set_int64_le : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_set_int64_be : t -> pos:Base.int -> Base.int -> Base.unit
64-bit unsigned values
val get_uint64_be_exn : t -> pos:Base.int -> Base.int
val get_uint64_le_exn : t -> pos:Base.int -> Base.int
val set_uint64_le_exn : t -> pos:Base.int -> Base.int -> Base.unit
val set_uint64_be_exn : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_get_uint64_be_exn : t -> pos:Base.int -> Base.int
val unsafe_get_uint64_le_exn : t -> pos:Base.int -> Base.int
val unsafe_set_uint64_le : t -> pos:Base.int -> Base.int -> Base.unit
val unsafe_set_uint64_be : t -> pos:Base.int -> Base.int -> Base.unit
32-bit methods with full precision
val get_int32_t_le : t -> pos:Base.int -> Base.Int32.t
val get_int32_t_be : t -> pos:Base.int -> Base.Int32.t
val set_int32_t_le : t -> pos:Base.int -> Base.Int32.t -> Base.unit
val set_int32_t_be : t -> pos:Base.int -> Base.Int32.t -> Base.unit
val unsafe_get_int32_t_le : t -> pos:Base.int -> Base.Int32.t
val unsafe_get_int32_t_be : t -> pos:Base.int -> Base.Int32.t
val unsafe_set_int32_t_le : t -> pos:Base.int -> Base.Int32.t -> Base.unit
val unsafe_set_int32_t_be : t -> pos:Base.int -> Base.Int32.t -> Base.unit
64-bit methods with full precision
val get_int64_t_le : t -> pos:Base.int -> Base.Int64.t
val get_int64_t_be : t -> pos:Base.int -> Base.Int64.t
val set_int64_t_le : t -> pos:Base.int -> Base.Int64.t -> Base.unit
val set_int64_t_be : t -> pos:Base.int -> Base.Int64.t -> Base.unit
val unsafe_get_int64_t_le : t -> pos:Base.int -> Base.Int64.t
val unsafe_get_int64_t_be : t -> pos:Base.int -> Base.Int64.t
val unsafe_set_int64_t_le : t -> pos:Base.int -> Base.Int64.t -> Base.unit
val unsafe_set_int64_t_be : t -> pos:Base.int -> Base.Int64.t -> Base.unit
module Private = Base_bigstring.Private
Creation and string conversion
val create : ?max_mem_waiting_gc:Core_kernel__.Byte_units0.t -> Core_kernel__.Import.int -> t
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
approachmax_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
bstr
that starts at positionpos
and 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:Core_kernel__.Import.int -> 'a Bin_prot.Type_class.writer -> 'a -> Core_kernel__.Import.int
write_bin_prot t writer a
writesa
tot
starting atpos
, and returns the index int
immediately after the last byte written. It raises ifpos < 0
or ifa
doesn't fit int
.
val read_bin_prot : t -> ?pos:Core_kernel__.Import.int -> ?len:Core_kernel__.Import.int -> 'a Bin_prot.Type_class.reader -> ('a * Core_kernel__.Import.int) Or_error.t
The
read_bin_prot*
functions read from the region oft
starting atpos
of lengthlen
. They return the index int
immediately after the last byte read. They raise ifpos
andlen
don't describe a region oft
.
val read_bin_prot_verbose_errors : t -> ?pos:Core_kernel__.Import.int -> ?len:Core_kernel__.Import.int -> 'a Bin_prot.Type_class.reader -> [ `Invalid_data of Error.t | `Not_enough_data | `Ok of 'a * Core_kernel__.Import.int ]
Destruction
val unsafe_destroy : t -> Core_kernel__.Import.unit
unsafe_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:Core_kernel__.Import.int -> t
unsafe_destroy_and_resize bstr ~len
reallocates the memory backingbstr
and returns a new bigstring that starts at position 0 and has lengthlen
. Iflen
is greater thanlength 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 tobstr
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:Core_kernel__.Import.char -> t -> pos:Core_kernel__.Import.int -> len:Core_kernel__.Import.int -> Core_kernel__.Import.unit -> Core_kernel__.Import.string
Similar to
Binary_packing.unpack_tail_padded_fixed_string
and.pack_tail_padded_fixed_string
.
val set_tail_padded_fixed_string : padding:Core_kernel__.Import.char -> t -> pos:Core_kernel__.Import.int -> len:Core_kernel__.Import.int -> Core_kernel__.Import.string -> Core_kernel__.Import.unit
val get_head_padded_fixed_string : padding:Core_kernel__.Import.char -> t -> pos:Core_kernel__.Import.int -> len:Core_kernel__.Import.int -> Core_kernel__.Import.unit -> Core_kernel__.Import.string
val set_head_padded_fixed_string : padding:Core_kernel__.Import.char -> t -> pos:Core_kernel__.Import.int -> len:Core_kernel__.Import.int -> Core_kernel__.Import.string -> Core_kernel__.Import.unit
module Unstable : sig ... end
module Stable : sig ... end