package grace

  1. Overview
  2. Docs
package grace
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Diagnostic.MessageSource

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

create str converts the string str into a message.

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

createf fmt ... formats a message.

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

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

Sourceval to_string : t -> string

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

Sourceval of_string : string -> t

alias of Message.create.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct