Module Identifiable.Make
Used for making an Identifiable module. Here's an example.
module Id = struct
module T = struct
type t = A | B [@@deriving_inline compare, hash, sexp][@@@end]
let of_string s = t_of_sexp (sexp_of_string s)
let to_string t = string_of_sexp (sexp_of_t t)
let module_name = "My_library.Std.Id"
end
include T
include Identifiable.Make (T)
end
Parameters
M : sig ... end
Signature
include Base.Pretty_printer.S with type t := M.t
val pp : Base.Formatter.t -> M.t -> unit
include Base.Comparable.S with type t := M.t
include Base__.Comparable_intf.Validate with type t := M.t
val validate_bound : min:M.t Base.Maybe_bound.t -> max:M.t Base.Maybe_bound.t -> M.t Base.Validate.check
val validate_ubound : max:M.t Base.Maybe_bound.t -> M.t Base.Validate.check
val validate_lbound : min:M.t Base.Maybe_bound.t -> M.t Base.Validate.check
include Base.Comparator.S with type t := M.t
val comparator : (M.t, comparator_witness) Base.Comparator.comparator
val clamp : M.t -> min:M.t -> max:M.t -> M.t Base.Or_error.t
val clamp_exn : M.t -> min:M.t -> max:M.t -> M.t
clamp_exn t ~min ~max
returnst'
, the closest value tot
such thatbetween t' ~low:min ~high:max
is true.Raises if
not (min <= max)
.
val descending : M.t -> M.t -> int
val ascending : M.t -> M.t -> int
ascending
is identical tocompare
.descending x y = ascending y x
. These are intended to be mnemonic when used likeList.sort ~compare:ascending
andList.sort ~cmp:descending
, since they cause the list to be sorted in ascending or descending order, respectively.
include Base__.Comparable_intf.Polymorphic_compare
include Base.Stringable.S with type t := M.t
val hash_fold_t : Base.Hash.state -> M.t -> Base.Hash.state
val hash : M.t -> Base.Hash.hash_value
include Base.Sexpable.S with type t := M.t
val t_of_sexp : Base.Sexp.t -> M.t
val sexp_of_t : M.t -> Base.Sexp.t