package textutils_kernel
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=793902157823c4112948514201a9e5c05126212b2b8d8b05a3cac786f752aa89
doc/textutils_kernel.utf8_text/Utf8_text/index.html
Module Utf8_textSource
This library is deprecated; use Core.String.Utf8 instead.
Text encoded in UTF-8.
include Ppx_quickcheck_runtime.Quickcheckable.S with type t := t
The invariant is that t is a sequence of well-formed UTF-8 code points.
include Core.Invariant.S with type t := t
include Core.Container.S0 with type t := t with type elt := Core.Uchar.t
Checks whether the provided element is there, using equality on elts.
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 -> Core.Uchar.t -> ('acc, 'e) Base.Result.t) ->
('acc, 'e) Base.Result.tfold_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 -> Core.Uchar.t -> ('acc, 'final) Base.Container.Continue_or_stop.t) ->
finish:('acc -> 'final) ->
'finalfold_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 -3Returns 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:(Core.Uchar.t -> 'sum) ->
'sumReturns 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.
width t approximates the display width of t. If you are migrating to String.Utf8, use String.Utf8.length_in_uchars, but see its documentation for why this is not a good way to compute display width.
bytes t is the number of bytes in the UTF-8 encoding of t. If you are migrating to String.Utf8, use String.length (t :> string).
iteri t ~f calls f index uchar for every uchar in t. index counts characters, not bytes.