Module Core_kernel.Substring

A substring is a contiguous set of characters within a string. Creating a substring does not copy. Therefore modifying the string also modifies the substring.

type base = bytes

The type of strings that type t is a substring of.

type t
include Container.S0 with type t := t with type elt := Core_kernel__.Import.char
type t
type elt
val mem : t ‑> elt ‑> bool

Checks whether the provided element is there, using equality on elts.

val length : t ‑> int
val is_empty : t ‑> bool
val iter : t ‑> f:(elt ‑> unit) ‑> unit

iter must allow exceptions raised in f to escape, terminating the iteration cleanly. The same holds for all functions below taking an f.

val fold : t ‑> init:'accum ‑> f:('accum ‑> elt ‑> 'accum) ‑> 'accum

fold t ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t.

val fold_result : t ‑> init:'accum ‑> f:('accum ‑> elt ‑> ('accum, 'e) Base.Result.t) ‑> ('accum, 'e) Base.Result.t

fold_result t ~init ~f is a short-circuiting version of fold that runs in the Result monad. If f returns an Error _, that value is returned without any additional invocations of f.

val fold_until : t ‑> init:'accum ‑> f:('accum ‑> elt ‑> ('accum, 'stop) Base.Container_intf.Continue_or_stop.t) ‑> ('accum, 'stop) Base.Container_intf.Finished_or_stopped_early.t

fold_until t ~init ~f is a short-circuiting version of fold. If f returns Stop _ the computation ceases and results in that value. If f returns Continue _, the fold will proceed.

val exists : t ‑> f:(elt ‑> bool) ‑> bool

Returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

val for_all : t ‑> f:(elt ‑> bool) ‑> bool

Returns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.

val count : t ‑> f:(elt ‑> bool) ‑> int

Returns the number of elements for which the provided function evaluates to true.

val sum : (module Base.Commutative_group.S with type t = 'sum) ‑> t ‑> f:(elt ‑> 'sum) ‑> 'sum

Returns the sum of f i for all i in the container.

val find : t ‑> f:(elt ‑> bool) ‑> elt option

Returns as an option the first element for which f evaluates to true.

val find_map : t ‑> f:(elt ‑> 'a option) ‑> 'a option

Returns the first evaluation of f that returns Some, and returns None if there is no such element.

val to_list : t ‑> elt list
val to_array : t ‑> elt array
val min_elt : t ‑> cmp:(elt ‑> elt ‑> int) ‑> elt option

Returns a min (resp. max) element from the collection using the provided cmp function. In case of a tie, the first element encountered while traversing the collection is returned. The implementation uses fold so it has the same complexity as fold. Returns None iff the collection is empty.

val max_elt : t ‑> cmp:(elt ‑> elt ‑> int) ‑> elt option
val base : t ‑> base
val pos : t ‑> Core_kernel__.Import.int

pos refers to the position in the base string, not any other substring that this substring was generated from.

val get : t ‑> Core_kernel__.Import.int ‑> Core_kernel__.Import.char

Per String.get and Bigstring.get, this raises an exception if the index is out of bounds.

val create : ?⁠pos:Core_kernel__.Import.int ‑> ?⁠len:Core_kernel__.Import.int ‑> base ‑> t

create ?pos ?len base creates a substring of the base sequence of length len starting at position pos, i.e.,

base.[pos], base.[pos + 1], ... base.[pos + len - 1]

An exception is raised if any of those indices into base is invalid.

It does not copy the characters, so mutating base mutates t and vice versa.

val sub : ?⁠pos:Core_kernel__.Import.int ‑> ?⁠len:Core_kernel__.Import.int ‑> t ‑> t

Blit functions

For copying characters from a substring to and from both strings and substrings.

val blit_to_string : t ‑> dst:Core_kernel__.Import.bytes ‑> dst_pos:Core_kernel__.Import.int ‑> Core_kernel__.Import.unit
val blit_to_bytes : t ‑> dst:Core_kernel__.Import.bytes ‑> dst_pos:Core_kernel__.Import.int ‑> Core_kernel__.Import.unit
val blit_to_bigstring : t ‑> dst:Bigstring.t ‑> dst_pos:Core_kernel__.Import.int ‑> Core_kernel__.Import.unit
val blit_from_string : t ‑> src:Core_kernel__.Import.string ‑> src_pos:Core_kernel__.Import.int ‑> len:Core_kernel__.Import.int ‑> Core_kernel__.Import.unit
val blit_from_bigstring : t ‑> src:Bigstring.t ‑> src_pos:Core_kernel__.Import.int ‑> len:Core_kernel__.Import.int ‑> Core_kernel__.Import.unit

String concatenation

These functions always copy.

val concat : t Core_kernel__.Import.list ‑> t
val concat_string : t Core_kernel__.Import.list ‑> Core_kernel__.Import.string
val concat_bigstring : t Core_kernel__.Import.list ‑> Bigstring.t

Conversion to/from substrings

These functions always copy.

val to_string : t ‑> Core_kernel__.Import.string
val to_bigstring : t ‑> Bigstring.t

These functions always copy. Use create if you want sharing.

val of_string : Core_kernel__.Import.string ‑> t
val of_bigstring : Bigstring.t ‑> t

Prefixes and suffixes

The result of these functions share data with their input, but don't mutate the underlying string.

val drop_prefix : t ‑> Core_kernel__.Import.int ‑> t
val drop_suffix : t ‑> Core_kernel__.Import.int ‑> t
val prefix : t ‑> Core_kernel__.Import.int ‑> t
val suffix : t ‑> Core_kernel__.Import.int ‑> t