textutils_kernel v0.17.0 (latest)

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

type 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

val compare : t Base__Ppx_compare_lib.compare

include Ppx_quickcheck_runtime.Quickcheckable.S with type t := t

val quickcheck_generator : t Base_quickcheck.Generator.t

val quickcheck_observer : t Base_quickcheck.Observer.t

val quickcheck_shrinker : t Base_quickcheck.Shrinker.t

val 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

val invariant : t Base__Invariant_intf.inv

include Core.Container.S0 with type t := t with type elt := Core.Uchar.t

val mem : t -> Core.Uchar.t -> bool

val length : t -> int

val is_empty : t -> bool

val iter : t -> f:(Core.Uchar.t -> unit) -> unit

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

val fold_result : 
  t ->
  init:'acc ->
  f:('acc -> Core.Uchar.t -> ('acc, 'e) Base__.Result.t) ->
  ('acc, 'e) Base__.Result.t

val fold_until : 
  t ->
  init:'acc ->
  f:
    ('acc ->
      Core.Uchar.t ->
      ('acc, 'final) Base__Container_intf.Continue_or_stop.t) ->
  finish:('acc -> 'final) ->
  'final

val exists : t -> f:(Core.Uchar.t -> bool) -> bool

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

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

val sum : 
  (module Base__Container_intf.Summable with type t = 'sum) ->
  t ->
  f:(Core.Uchar.t -> 'sum) ->
  'sum

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

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

val to_list : t -> Core.Uchar.t list

val to_array : t -> Core.Uchar.t array

val min_elt : 
  t ->
  compare:(Core.Uchar.t -> Core.Uchar.t -> int) ->
  Core.Uchar.t option

val max_elt : 
  t ->
  compare:(Core.Uchar.t -> Core.Uchar.t -> int) ->
  Core.Uchar.t option

include Core.Stringable.S with type t := t

val of_string : string -> t

val to_string : t -> string

module Stable : sig ... end

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

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

val of_uchar_list : Core.Uchar.t list -> t

val concat : ?sep:t -> t list -> t

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

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

package textutils_kernel