package core

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

Source file unique_id_intf.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
(** Signature for use by {{!module:Core.Unique_id}[Unique_id]}. *)

open! Import
open Std_internal

module type Id = sig
  (** The sexps and strings look like integers. *)
  type t [@@deriving bin_io, hash, sexp, typerep]

  (** {b Caveat}: values created with [of_float], [of_sexp], or [of_string] may be equal
      to previously created values. *)
  include Comparable.S_binable with type t := t

  include Hashable.S_binable with type t := t
  include Intable with type t := t
  include Stringable with type t := t

  (** Always returns a value that is not equal to any other value created with
      [create]. *)
  val create : unit -> t

  module For_testing : sig
    (** Resets the counter to its default starting value. The nth call to [create] after
        [reset_counter] has been called has the same ID value as the nth call to [create]
        after the start of the program (before [reset_counter] has been called).

        This should only be used in testing to set up a deterministic environment when
        potentially running multiple tests in a row, because calling this will break the
        guarantee that [create] always returns a unique value. *)
    val reset_counter : unit -> unit
  end
end