Module S.Interned

include Immediate_kernel.S_no_option
type t
include Core.Bin_prot.Binable.S__local with type t := t
include Bin_prot.Binable.S_only_functions__local with type t := t
include sig ... end
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_compare_lib.Comparable.S__local with type t := t
include Ppx_compare_lib.Equal.S with type t := t
include Ppx_compare_lib.Equal.S__local with type t := t
val globalize : t @ local -> t
include Ppx_hash_lib.Hashable.S_any with type t := t
include Typerep_lib.Typerepable.S with type t := t
val typerep_of_t : t Typerep_lib.Std_internal.Typerep.t @@ portable
val typename_of_t : t Typerep_lib.Typename.t @@ portable
include Core.Identifiable.S with type t := t
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
include sig ... end
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : t Bin_prot.Read.vtag_reader

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.

val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
include Ppx_hash_lib.Hashable.S_any with type t := t
include Sexplib0.Sexpable.S with type t := t
include Sexplib0.Sexpable.Of_sexp with type t := t
include Sexplib0.Sexpable.Sexp_of with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S_any with type t := t
include Base.Stringable.S with type t := t
val of_string : string -> t
include Base.Pretty_printer.S with type t := t
val pp : Base.Formatter.t -> t -> unit
include Core.Comparable.S_binable 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.Comparator.S with type t := t with type comparator_witness := comparator_witness
include Core.Hashable.S_binable with type t := t
include Ppx_hash_lib.Hashable.S_any with type t := t
val hash_fold_t : t Ppx_hash_lib.hash_fold
val hashable : t Base.Hashable.t
module Table : Core.Hashtbl.S_binable with type key = t
module Hash_set : Core.Hash_set.S_binable with type elt = t
module Hash_queue : Core.Hash_queue.S with type key = t
include Core.Quickcheckable with type t := t
val quickcheck_generator : t Base_quickcheck.Generator.t
val quickcheck_observer : t Base_quickcheck.Observer.t
val quickcheck_shrinker : t Base_quickcheck.Shrinker.t
include Core.Sexpable.S_with_grammar with type t := t
include Sexplib0.Sexpable.S with type t := t
include Sexplib0.Sexpable.Of_sexp with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
include Sexplib0.Sexpable.Sexp_of with type t := t
val sexp_of_t : t -> Sexplib0.Sexp.t
val t_sexp_grammar : t Sexplib0.Sexp_grammar.t @@ portable

Lexicographic.compare x y = String.compare (to_string x) (to_string y)

include Core.Intable with type t := t
val of_int_exn : int -> t
val to_int_exn : t @ local -> int
val empty : t
val unsafe_of_bigstring : pos:int -> len:int -> Core.Bigstring.t @ local -> t
val of_iobuf_peek : ?pos:int @ local -> (?len:int @ local -> (([> Core.read ], _, _) Iobuf.t @ local -> t) @ local) @ local
val of_iobuf_consume : ?len:int @ local -> (([> Core.read ], Iobuf.seek, _) Iobuf.t @ local -> t) @ local
val to_iobuf_poke : t -> ?pos:int @ local -> ((Core.read_write, _, _) Iobuf.t @ local -> unit) @ local
val to_iobuf_fill : t -> (Core.read_write, Iobuf.seek, _) Iobuf.t @ local -> unit
module Padded : sig ... end

WARNING: using the padded functions to convert to a bigstring / iobuf will ignore ~len arguments that are less than the length of the source t!

val unsafe_get : t -> int -> char
val unsafe_of_iobuf_peek : pos:int -> len:int -> ([> Core.read ], _, _) Iobuf.t @ local -> t
val unsafe_of_iobuf_consume : len:int -> ([> Core.read ], Iobuf.seek, _) Iobuf.t @ local -> t
val unsafe_to_iobuf_poke : t -> pos:int -> (Core.read_write, _, _) Iobuf.t @ local -> unit
val unsafe_to_iobuf_fill : t -> (Core.read_write, Iobuf.seek, _) Iobuf.t @ local -> unit
val unsafe_to_bigstring : t -> pos:int -> Core.Bigstring.t @ local -> unit
val length : t -> int
val get : t -> int -> char
val of_char : char -> t
val mem : t -> char -> bool
val unsafe_to_int : t -> int
val unsafe_of_int : int -> t
val is_empty : t -> bool
module Stats : sig ... end
val grow_by : int -> unit

grow_by n ensures that the intern table can hold at least n additional entries without resizing (again). This is useful for applications which must not pause online for the (substantial) time required to rehash a large intern table.

val after_grow : (before:Core.Time_ns.t -> len_before:int -> len:int -> unit) -> unit

after_grow f registers a growth logger. f will be called immediately after every growth of the intern table, with the time and size before and the size after.

f would typically call Time_ns.now to learn the time after.

module Stable : sig ... end
module Option : sig ... end
val of_string_no_intern : string @ local -> Option.t
val of_local_string : string @ local -> t
val to_string : t -> string