Caseless (core.core.Core.String.Caseless)

Module String.Caseless

Caseless compares and hashes strings ignoring case, so that for example Caseless.equal "OCaml" "ocaml" and Caseless.("apple" < "Banana") are true, and Caseless.Map, Caseless.Table lookup and Caseless.Set membership is case-insensitive.

Caseless also provides case-insensitive is_suffix and is_prefix functions, so that for example Caseless.is_suffix "OCaml" ~suffix:"AmL" and Caseless.is_prefix "OCaml" ~prefix:"oc" are true.

include module type of struct include Base.String.Caseless end

include Ppx_hash_lib.Hashable.S_any with type t := Base.String.t

include Sexplib0.Sexpable.S__stack with type t := Base.String.t

include Sexplib0.Sexpable.Of_sexp with type t := Base.String.t

include Sexplib0.Sexpable.Sexp_of__stack with type t := Base.String.t

val t_sexp_grammar : Base.String.t Sexplib0.Sexp_grammar.t @@ portable

include Base.Comparable.S__portable with type t := Base.String.t

include Base.Comparisons.S with type t := Base.String.t

include Base.Comparisons.Infix with type t := Base.String.t

include Base.Comparator.S__portable with type t := Base.String.t

include Ppx_compare_lib.Comparable.S__local with type t := Base.String.t

val is_suffix : 
  Base.String.t @ local ->
  (suffix:Base.String.t @ local ->
  bool) @ local

val is_prefix : 
  Base.String.t @ local ->
  (prefix:Base.String.t @ local ->
  bool) @ local

val is_substring : 
  Base.String.t @ local ->
  (substring:Base.String.t @ local ->
  bool) @ local

val is_substring_at : 
  Base.String.t @ local ->
  (pos:int ->
  (substring:Base.String.t @ local ->
  bool) @ local) @ local

val substr_index : 
  ?pos:int ->
  Base.String.t @ local ->
  (pattern:Base.String.t @ local ->
  int option) @ local

val substr_index_exn : 
  ?pos:int ->
  Base.String.t @ local ->
  (pattern:Base.String.t ->
  int) @ local

val substr_index_all : 
  Base.String.t @ local ->
  (may_overlap:bool ->
  (pattern:Base.String.t @ local ->
  int list) @ local) @ local

val substr_replace_first : 
  ?pos:int ->
  Base.String.t ->
  pattern:Base.String.t @ local ->
  (with_:Base.String.t @ local ->
  Base.String.t) @ local

val substr_replace_all : 
  Base.String.t ->
  pattern:Base.String.t @ local ->
  (with_:Base.String.t @ local ->
  Base.String.t) @ local

type nonrec t = Base.String.t

include Bin_prot.Binable.S__local with type t := t

include Bin_prot.Binable.S_only_functions__local with type t := t

include sig ... end

val bin_size_t : t Bin_prot.Size.sizer

val bin_write_t : t Bin_prot.Write.writer

val bin_read_t : t Bin_prot.Read.reader

val __bin_read_t__ : t Bin_prot.Read.vtag_reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

val bin_shape_t : Bin_prot.Shape.t

val bin_writer_t : t Bin_prot.Type_class.writer

val bin_reader_t : t Bin_prot.Type_class.reader

val bin_t : t Bin_prot.Type_class.t

include Ppx_hash_lib.Hashable.S_any with type t := t

include Sexplib0.Sexpable.S with type t := t

include Sexplib0.Sexpable.Of_sexp with type t := t

val t_of_sexp : Sexplib0.Sexp.t -> t

include Sexplib0.Sexpable.Sexp_of with type t := t

val sexp_of_t : t -> Sexplib0.Sexp.t

include Base.Comparable.S__local__portable with type t := t

include Base.Comparisons.S__local with type t := t

include Base.Comparisons.Infix with type t := t

val (>=) : t -> t -> bool

val (<=) : t -> t -> bool

val (=) : t -> t -> bool

val (>) : t -> t -> bool

val (<) : t -> t -> bool

val (<>) : t -> t -> bool

val equal : t -> t -> bool

val compare : t -> t -> int

compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.

val min : t -> t -> t

val max : t -> t -> t

val ascending : t -> t -> int @@ portable

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t -> t -> int @@ portable

val between : t -> low:t -> high:t -> bool @@ portable

between t ~low ~high means low <= t <= high

val clamp_exn : t -> min:t -> max:t -> t @@ portable

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

val clamp : t -> min:t -> max:t -> t Base.Or_error.t @@ portable

include Base.Comparator.S__portable with type t := t

type comparator_witness

val validate_lbound : min:t Maybe_bound.t -> t Validate.check

val validate_ubound : max:t Maybe_bound.t -> t Validate.check

val validate_bound : 
  min:t Maybe_bound.t ->
  max:t Maybe_bound.t ->
  t Validate.check

module Replace_polymorphic_compare : 
  Base.Comparable.Comparisons__local with type t := t

include Comparator.S__portable
  with type t := t
  with type comparator_witness := comparator_witness

val comparator : (t, comparator_witness) Base.Comparator.T.comparator

module Map : 
  Map_intf.S_binable__portable
    with type Key.t = t
    with type Key.comparator_witness = comparator_witness

module Set : 
  Set_intf.S_binable__portable
    with type Elt.t = t
    with type Elt.comparator_witness = comparator_witness

include Hashable.S_binable with type t := t

include Ppx_hash_lib.Hashable.S_any with type t := t

val hash_fold_t : t Ppx_hash_lib.hash_fold

val hash : t -> Ppx_hash_lib.Std.Hash.hash_value

val hashable : t Base.Hashable.t

module Table : Hashtbl.S_binable with type key = t

module Hash_set : Hash_set.S_binable with type elt = t

module Hash_queue : Hash_queue.S with type key = t