Up

Module Color

Signature

type t =
| Black
| Red
| Green
| Yellow
| Blue
| Magenta
| Cyan
| White
| Default
| Gray
| Bright_black
| Bright_red
| Bright_green
| Bright_yellow
| Bright_blue
| Bright_magenta
| Bright_cyan
| Bright_white
| RGB6 of Import.ANSITerminal.RGB6.t
| Gray24 of Import.ANSITerminal.Gray24.t
val t_of_sexp : Sexplib.Sexp.t -> t
val sexp_of_t : t -> Sexplib.Sexp.t
val compare : t -> t -> int
include Core.Std.Comparable.S with type t := t
include Comparable_intf.S_common
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
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
val rgb6_exn : int * int * int -> t

From the documentation of Ansi_terminal.ANSITerminal:

RGB(r,g,b): expected (0 ≤ r, g, b < 6) GRAY24(level): expected (0 ≤ level < 24)

rgb6_exn r g b and gray24_exn level raise if the values are out of bound.

val gray24_exn : int -> t