package base

  1. Overview
  2. Docs
Full standard library replacement for OCaml

Install 

dune-project
 Dependency

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

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.3.tar.gz
md5=2100b0ed13fecf43be86ed45c5b2cc4d
sha512=628610caff7e124631870fa1e29661caac28bdfdb18750ee43b868037da3d65d6dd9023b4be7c4c52405679efb5e865a6632d95606a22b28a36636a6bf706ef3

doc/base/Base/Char/index.html

Module Base.CharSource

A type for 8-bit characters.

Sourcetype t = char

An alias for the type of characters.

Sourceval all : t list
Sourceval globalize : t -> t
include Sexplib0.Sexpable.S with type t := t
Sourceval t_sexp_grammar : t Sexplib0.Sexp_grammar.t
include Identifiable.S with type t := t
Sourceval hash_fold_t : Hash.state -> t -> Hash.state
Sourceval hash : t -> Hash.hash_value
include Sexplib0.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
include Stringable.S with type t := t
Sourceval of_string : string -> t
Sourceval to_string : t -> string
include Comparable.S with type t := t
include Comparisons.S with type t := t
include Comparisons.Infix with type t := t
Sourceval (>=) : t -> t -> bool
Sourceval (<=) : t -> t -> bool
Sourceval (=) : t -> t -> bool
Sourceval (>) : t -> t -> bool
Sourceval (<) : t -> t -> bool
Sourceval (<>) : t -> t -> bool
Sourceval equal : t -> t -> bool
Sourceval 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.

Sourceval min : t -> t -> t
Sourceval max : t -> t -> t
Sourceval 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 ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

Sourceval descending : t -> t -> int
Sourceval between : t -> low:t -> high:t -> bool

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

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

Sourceval clamp : t -> min:t -> max:t -> t Or_error.t
include Comparator.S with type t := t
Sourcetype comparator_witness
include Pretty_printer.S with type t := t
Sourceval pp : Formatter.t -> t -> unit
Sourceval hashable : t Hashable.t
Sourceval equal__local : t -> t -> bool
Sourceval compare__local : t -> t -> int
include Invariant.S with type t := t
Sourceval invariant : t -> unit
Sourcemodule O : Comparisons.Infix with type t := t
Sourceval to_int : t -> int

Returns the ASCII code of the argument.

Sourceval of_int : int -> t option

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

Sourceval of_int_exn : int -> t

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

Sourceval unsafe_of_int : int -> t
Sourceval escaped : t -> string

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

Sourceval lowercase : t -> t

Converts the given character to its equivalent lowercase character.

Sourceval uppercase : t -> t

Converts the given character to its equivalent uppercase character.

Sourceval is_digit : t -> bool

'0' - '9'

Sourceval is_lowercase : t -> bool

'a' - 'z'

Sourceval is_uppercase : t -> bool

'A' - 'Z'

Sourceval is_alpha : t -> bool

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

Sourceval is_alphanum : t -> bool

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

Sourceval is_print : t -> bool

' ' - '~'

Sourceval is_whitespace : t -> bool

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

Sourceval get_digit : t -> int option

Returns Some i if is_digit c and None otherwise.

Sourceval get_digit_exn : t -> int

Returns i if is_digit c and raises Failure otherwise.

Sourceval is_hex_digit : t -> bool

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

Sourceval is_hex_digit_lower : t -> bool

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

Sourceval is_hex_digit_upper : t -> bool

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

Sourceval get_hex_digit : t -> int option

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

Sourceval get_hex_digit_exn : t -> int

Same as get_hex_digit but raises instead of returning None.

Sourceval min_value : t
Sourceval max_value : t
Sourcemodule Caseless : sig ... end

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