package textutils_kernel

  1. Overview
  2. Docs
Text output utilities

Install 

dune-project
 Dependency

github.com Changelog MIT License Edit opam file Versions (6)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.0.tar.gz
sha256=793902157823c4112948514201a9e5c05126212b2b8d8b05a3cac786f752aa89

doc/textutils_kernel.utf8_text/Utf8_text/index.html

Module Utf8_textSource

This library is deprecated; use Core.String.Utf8 instead.

Sourcetype t

Text encoded in UTF-8.

  • deprecated [since 2023-12] Use [String.Utf8.t] instead.
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval compare : t -> t -> int
include Ppx_quickcheck_runtime.Quickcheckable.S with type t := t
Sourceval quickcheck_generator : t Base_quickcheck.Generator.t
Sourceval quickcheck_observer : t Base_quickcheck.Observer.t
Sourceval quickcheck_shrinker : t Base_quickcheck.Shrinker.t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

The invariant is that t is a sequence of well-formed UTF-8 code points.

include Core.Invariant.S with type t := t
Sourceval invariant : t -> unit
include Core.Container.S0 with type t := t with type elt := Core.Uchar.t
Sourceval mem : t -> Core.Uchar.t -> bool

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

Sourceval length : t -> int
Sourceval is_empty : t -> bool
Sourceval iter : t -> f:(Core.Uchar.t -> 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.

Sourceval fold : t -> init:'acc -> f:('acc -> Core.Uchar.t -> 'acc) -> 'acc

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

Sourceval fold_result : t -> init:'acc -> f:('acc -> Core.Uchar.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.

Sourceval fold_until : t -> init:'acc -> f:('acc -> Core.Uchar.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
Sourceval exists : t -> f:(Core.Uchar.t -> 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.

Sourceval for_all : t -> f:(Core.Uchar.t -> bool) -> bool

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

Sourceval count : t -> f:(Core.Uchar.t -> bool) -> int

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

Sourceval sum : (module Base.Container.Summable with type t = 'sum) -> t -> f:(Core.Uchar.t -> 'sum) -> 'sum

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

Sourceval find : t -> f:(Core.Uchar.t -> bool) -> Core.Uchar.t option

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

Sourceval find_map : t -> f:(Core.Uchar.t -> 'a option) -> 'a option

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

Sourceval to_list : t -> Core.Uchar.t list
Sourceval to_array : t -> Core.Uchar.t array
Sourceval min_elt : t -> compare:(Core.Uchar.t -> Core.Uchar.t -> int) -> Core.Uchar.t option

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.

Sourceval max_elt : t -> compare:(Core.Uchar.t -> Core.Uchar.t -> int) -> Core.Uchar.t option
include Core.Stringable.S with type t := t
Sourceval of_string : string -> t
Sourceval to_string : t -> string
Sourcemodule Stable : sig ... end
Sourceval width : t -> int

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.

Sourceval bytes : t -> int

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).

Sourceval of_uchar_list : Core.Uchar.t list -> t
Sourceval concat : ?sep:t -> t list -> t
Sourceval iteri : t -> f:(int -> Core.Uchar.t -> unit) -> unit

iteri t ~f calls f index uchar for every uchar in t. index counts characters, not bytes.

Sourceval split : t -> on:char -> t list

split t ~on returns the substrings between and not including occurrences of on. on must be an ASCII char (in range '\000' to '\127').