Module Base.Char

A type for 8-bit characters.

type t = char

An alias for the type of characters.

include Ppx_enumerate_lib.Enumerable.S with type t := t
val all : t list
val globalize : t @ local -> t
include Sexplib0.Sexpable.S__stack with type t := t
include Sexplib0.Sexpable.Of_sexp with type t := t
include Sexplib0.Sexpable.Sexp_of__stack with type t := t
val t_sexp_grammar : t Sexplib0.Sexp_grammar.t @@ portable
include Identifiable.S__local__portable 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
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 Stringable.S with type t := t
val of_string : string -> t
val to_string : t -> string
include Comparable.S__local__portable with type t := t
include Comparisons.S__local with type t := t
include 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 Or_error.t @@ portable
include Comparator.S__portable with type t := t
type comparator_witness
include Pretty_printer.S with type t := t
val pp : Formatter.t -> t -> unit
val hashable : t Hashable.t
include Invariant.S with type t := t
val invariant : t -> unit
module O : Comparisons.Infix with type t := t
val to_int : t -> int @@ portable

Returns the ASCII code of the argument.

val of_int : int -> t option @@ portable

Returns 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 @@ portable

Returns the character with the given ASCII code. Raises Failure if the argument is outside the range 0 to 255.

val unsafe_of_int : int -> t @@ portable
val escaped : t -> string @@ portable

Returns a string representing the given character, with special characters escaped following the lexical conventions of OCaml.

val lowercase : t -> t @@ portable

Converts the given character to its equivalent lowercase character.

val uppercase : t -> t @@ portable

Converts the given character to its equivalent uppercase character.

val is_digit : t -> bool @@ portable

'0' - '9'

val is_lowercase : t -> bool @@ portable

'a' - 'z'

val is_uppercase : t -> bool @@ portable

'A' - 'Z'

val is_alpha : t -> bool @@ portable

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

val is_alphanum : t -> bool @@ portable

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

val is_print : t -> bool @@ portable

' ' - '~'

val is_whitespace : t -> bool @@ portable

' ' or '\t' or '\r' or '\n' or '\011' (vertical tab) or '\012' (form feed)

val get_digit : t -> int option @@ portable

Returns Some i if is_digit c and None otherwise.

val get_digit_exn : t -> int @@ portable

Returns i if is_digit c and raises Failure otherwise.

val is_hex_digit : t -> bool @@ portable

'0' - '9' or 'a' - 'f' or 'A' - 'F'

val is_hex_digit_lower : t -> bool @@ portable

'0' - '9' or 'a' - 'f'

val is_hex_digit_upper : t -> bool @@ portable

'0' - '9' or 'A' - 'F'

val get_hex_digit : t -> int option @@ portable

Returns Some i where 0 <= i && i < 16 if is_hex_digit c and None otherwise.

val get_hex_digit_exn : t -> int @@ portable

Same as get_hex_digit but raises instead of returning None.

val min_value : t @@ portable
val max_value : t @@ portable
module Caseless : sig ... end

Caseless compares and hashes characters ignoring case, so that for example Caseless.equal 'A' 'a' and Caseless.('a' < 'B') are true.