Module Base.Char

Character operations.

type t = char

An alias for the type of characters.

include sig ... end
val t_of_sexp : Base__.Sexplib.Sexp.t ‑> t
val sexp_of_t : t ‑> Base__.Sexplib.Sexp.t
val all : t list
include Identifiable.S with type t := t
type t
include sig ... end
val t_of_sexp : Base__.Sexplib.Sexp.t ‑> t
val sexp_of_t : t ‑> Base__.Sexplib.Sexp.t
include Stringable.S with type t := t
type t
val of_string : string ‑> t
val to_string : t ‑> string
include Comparable.S with type t := t
include Comparable_intf.Polymorphic_compare
include Polymorphic_compare_intf.Infix
type 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

-1 means "less than", 0 means "equal", 1 means "greater than", and other values should not be returned

val min : t ‑> t ‑> t
val max : t ‑> t ‑> t
val ascending : t ‑> t ‑> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~cmp: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
val between : t ‑> low:t ‑> high:t ‑> bool
val clamp_exn : t ‑> min:t ‑> max:t ‑> t

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 Or_error.t
include Comparator.S with type t := t
type t
type comparator_witness
include Comparable_intf.Validate with type t := t
type t
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
include Pretty_printer.S with type t := t
type t
val pp : Caml.Format.formatter ‑> t ‑> unit
val to_int : t ‑> int

Return the ASCII code of the argument.

val of_int : int ‑> t option

Return the character with the given ASCII code or None is the argument is outside the range 0 to 255.

val of_int_exn : int ‑> t

Return the character with the given ASCII code. Raise Failure if the argument is outside 0 to 255.

val unsafe_of_int : int ‑> t
val escaped : t ‑> string

Return a string representing the given character, with special characters escaped following the lexical conventions of Objective Caml.

val lowercase : t ‑> t

Convert the given character to its equivalent lowercase character.

val uppercase : t ‑> t

Convert the given character to its equivalent uppercase character.

val is_digit : t ‑> bool

'0' - '9'

val is_lowercase : t ‑> bool

'a' - 'z'

val is_uppercase : t ‑> bool

'A' - 'Z'

val is_alpha : t ‑> bool

'a' - 'z' or 'A' - 'Z'

val is_alphanum : t ‑> bool

'a' - 'z' or 'A' - 'Z' or '0' - '9'

val is_print : t ‑> bool

' ' - '~'

val is_whitespace : t ‑> bool

' ' or '\t' or '\r' or '\n'

val get_digit : t ‑> int option

Return Some i if is_digit c and None otherwise.

val get_digit_exn : t ‑> int

Return i if is_digit c. Raises Failure otherwise.

val min_value : t
val max_value : t