package grace

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = Format.formatter -> unit

The type of messages.

Messages are unrendered formatted strings. The rendering is delayed till Grace's renderering engine since layout decisions are it's responsibility.

A valid message must satisfy the following two conditions:

  1. Messages must be encoded using ASCII.
  2. Messages must not contain control characters such as the newline character \n.

Equality and comparison of messages is performed on the hash of the messages rendered contents.

include Ppx_compare_lib.Equal.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
include Sexplib0.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Core.Comparable.S with type t := t
include Base.Comparable.S with type t := t
include Base.Comparisons.S 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

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
val between : t -> low:t -> high:t -> bool

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

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 Base.Or_error.t
include Base.Comparator.S with type t := t
type comparator_witness
val validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
val validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
include Core.Pretty_printer.S with type t := t
val pp : Base.Formatter.t -> t -> unit
val create : string -> t

create str converts the string str into a message.

val createf : ('a, t) format -> 'a

createf fmt ... formats a message.

val kcreatef : (t -> 'b) -> ('a, 'b) format -> 'a

kcreatef kont fmt ... is equivalent to kont (createf fmt ...).

val to_string : t -> string

converts a message into a string by formatting it with the maximum admissible margin.

val of_string : string -> t

alias of Message.create.

OCaml

Innovation. Community. Security.