Text is text encoded in UTF-8.
Under the hood, this is just a String.t, but the type is abstract so that the compiler will remind us not to use String.length when we mean Text.width.
include Ppx_compare_lib.Comparable.S with type t := tinclude Ppx_quickcheck_runtime.Quickcheckable.S with type t := tval quickcheck_generator : t Base_quickcheck.Generator.tval quickcheck_observer : t Base_quickcheck.Observer.tval quickcheck_shrinker : t Base_quickcheck.Shrinker.tval sexp_of_t : t -> Sexplib0.Sexp.tThe invariant is that t is a sequence of well-formed UTF-8 code points.
include Core.Invariant.S with type t := tval invariant : t -> unitinclude Core.Container.S0 with type t := t with type elt := Core.Uchar.tval mem : t -> Core.Uchar.t -> boolChecks whether the provided element is there, using equality on elts.
val length : t -> intval is_empty : t -> boolval iter : t -> f:(Core.Uchar.t -> unit) -> unititer 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:'acc -> f:('acc -> Core.Uchar.t -> 'acc) -> 'accfold 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 -3val exists : t -> f:(Core.Uchar.t -> bool) -> boolReturns 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:(Core.Uchar.t -> bool) -> boolReturns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.
val count : t -> f:(Core.Uchar.t -> bool) -> intReturns 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.
val find : t -> f:(Core.Uchar.t -> bool) -> Core.Uchar.t optionReturns as an option the first element for which f evaluates to true.
val find_map : t -> f:(Core.Uchar.t -> 'a option) -> 'a optionReturns the first evaluation of f that returns Some, and returns None if there is no such element.
val to_list : t -> Core.Uchar.t listval to_array : t -> Core.Uchar.t arrayval min_elt :
t ->
compare:(Core.Uchar.t -> Core.Uchar.t -> int) ->
Core.Uchar.t optionReturns 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.
val max_elt :
t ->
compare:(Core.Uchar.t -> Core.Uchar.t -> int) ->
Core.Uchar.t optionval width : t -> intwidth t approximates the displayed width of t.
We incorrectly assume that every code point has the same width. This is better than String.length for many code points, but doesn't work for double-width characters or combining diacritics.
val bytes : t -> intbytes t is the number of bytes in the UTF-8 encoding of t.
chunks_of t ~width splits t into chunks no wider than width characters s.t.
t = t |> chunks_of ~width |> concat. chunks_of always returns at least one chunk, which may be empty.
If prefer_split_on_spaces = true and such a space exists, t will be split on the last U+020 SPACE before the chunk becomes too wide. Otherwise, the split happens exactly at width characters.
val of_uchar_list : Core.Uchar.t list -> tval iteri : t -> f:(int -> Core.Uchar.t -> unit) -> unititeri t ~f calls f index uchar for every uchar in t. index counts characters, not bytes.