package core
Install
Dune Dependency
Authors
Maintainers
Sources
md5=743a141234e04210e295980f7a78a6d9
sha512=61b415f4fb12c78d30649fff1aabe3a475eea926ce6edb7774031f4dc7f37ea51f5d9337ead6ec73cd93da5fd1ed0f2738c210c71ebc8fe9d7f6135a06bd176f
doc/core/Core/Substring/index.html
Module Core.Substring
Source
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.
The type of strings that type t
is a substring of.
sexp_of_t
is equivalent to String.sexp_of_t (to_string t)
include Ppx_quickcheck_runtime.Quickcheckable.S with type t := t
include Indexed_container.S0 with type t := t with type elt := Base.Char.t
include Base.Container.S0 with type t := t with type elt := Base.Char.t
Checks whether the provided element is there, using equality on elt
s.
iter
must allow exceptions raised in f
to escape, terminating the iteration cleanly. The same holds for all functions below taking an f
.
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:'acc ->
f:('acc -> Base.Char.t -> ('acc, 'e) Base.Result.t) ->
('acc, '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:'acc ->
f:('acc -> Base.Char.t -> ('acc, 'final) Base.Container.Continue_or_stop.t) ->
finish:('acc -> 'final) ->
'final
fold_until t ~init ~f ~finish
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. If f
never returns Stop _
, the final result is computed by finish
.
Example:
type maybe_negative =
| Found_negative of int
| All_nonnegative of { sum : int }
(** [first_neg_or_sum list] returns the first negative number in [list], if any,
otherwise returns the sum of the list. *)
let first_neg_or_sum =
List.fold_until ~init:0
~f:(fun sum x ->
if x < 0
then Stop (Found_negative x)
else Continue (sum + x))
~finish:(fun sum -> All_nonnegative { sum })
;;
let x = first_neg_or_sum [1; 2; 3; 4; 5]
val x : maybe_negative = All_nonnegative {sum = 15}
let y = first_neg_or_sum [1; 2; -3; 4; 5]
val y : maybe_negative = Found_negative -3
Returns true
if and only if there exists an element for which the provided function evaluates to true
. This is a short-circuiting operation.
Returns true
if and only if the provided function evaluates to true
for all elements. This is a short-circuiting operation.
Returns the number of elements for which the provided function evaluates to true.
val sum :
(module Base.Container.Summable with type t = 'sum) ->
t ->
f:(Base.Char.t -> 'sum) ->
'sum
Returns the sum of f i
for all i
in the container.
Returns as an option
the first element for which f
evaluates to true.
Returns the first evaluation of f
that returns Some
, and returns None
if there is no such element.
Returns a min (resp. max) element from the collection using the provided compare
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.
These are all like their equivalents in Container
except that an index starting at 0 is added as the first argument to f
.
pos
refers to the position in the base string, not any other substring that this substring was generated from.
Per String.get
and Bigstring.get
, this raises an exception if the index is out of bounds.
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.
Blit functions
For copying characters from a substring to and from both strings and substrings.
val blit_from_string :
t ->
src:Base.String.t ->
src_pos:Base.Int.t ->
len:Base.Int.t ->
Base.Unit.t
val blit_from_bigstring :
t ->
src:Bigstring.t ->
src_pos:Base.Int.t ->
len:Base.Int.t ->
Base.Unit.t
String concatenation
These functions always copy.
Conversion to/from substrings
These functions always copy.
These functions always copy. Use create
if you want sharing.
Prefixes and suffixes
The result of these functions share data with their input, but don't mutate the underlying string.