Module Base.RefSource

Module for the type ref, mutable indirection cells r containing a value of type 'a, accessed with !r and set by r := a.

Sourcetype 'a t = 'a ref = {
  1. mutable contents : 'a;
}
Sourceval compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
Sourceval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
Sourceval globalize : ('a -> 'a) -> 'a t -> 'a t
include Sexplib0.Sexpable.S1 with type 'a t := 'a t
Sourceval t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a t
Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
Sourceval create : 'a -> 'a t
Sourceval (!) : 'a t -> 'a
Sourceval (:=) : 'a t -> 'a -> unit
Sourceval swap : 'a t -> 'a t -> unit

swap t1 t2 swaps the values in t1 and t2.

Sourceval replace : 'a t -> ('a -> 'a) -> unit

replace t f is t := f !t

Sourceval set_temporarily : 'a t -> 'a -> f:(unit -> 'b) -> 'b

set_temporarily t a ~f sets t to a, calls f (), and then restores t to its value prior to set_temporarily being called, whether f returns or raises.

Sourcemodule And_value : sig ... end
Sourceval sets_temporarily : And_value.t list -> f:(unit -> 'a) -> 'a

sets_temporarily [ ...; T (ti, ai); ... ] ~f sets each ti to ai, calls f (), and then restores all ti to their value prior to sets_temporarily being called, whether f returns or raises.