Core.String_id
SourceLike Identifiable
, but with t = private string
and stable modules.
include S
include Ppx_compare_lib.Equal.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
include Interfaces.Identifiable with type t := t
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
This function only needs implementation if t
exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t
afterwards.
include Ppx_hash_lib.Hashable.S with type t := t
include Sexplib0.Sexpable.S with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
include Base.Pretty_printer.S with type t := t
include Comparable.S_binable with type t := t
include Base.Comparable.S with type t := t
include Base.Comparisons.S with type t := t
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
.
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.
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)
.
include Base.Comparator.S with type t := t
include Comparator.S
with type t := t
with type comparator_witness := comparator_witness
module Map :
Map.S_binable
with type Key.t = t
with type Key.comparator_witness = comparator_witness
module Set :
Set.S_binable
with type Elt.t = t
with type Elt.comparator_witness = comparator_witness
include Diffable.S_atomic with type t := t
Make
customizes the error messages generated by of_string
/of_sexp
to include module_name
. It also registers a pretty printer.
Like Make
, but lets you specify a caller_identity
to ensure that the bin-shape is distinct, which helps catch serialization bugs where identifiers with different meanings get confused with each other.
Make_with_validate
is like Make
, but modifies of_string
/of_sexp
/bin_read_t
to raise if validate
returns an error. Before using this functor one should be mindful of the performance implications (the validate
function will run every time an instance is created) as well as potential versioning issues (when validate
changes old binaries still run the old version of the function).
This does what Make
does without registering a pretty printer. Use this when the module that is made is not exposed in mli. Registering a pretty printer without exposing it causes an error in utop.
See Make_with_validate
and Make_without_pretty_printer