mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
48 lines
1.3 KiB
OCaml
48 lines
1.3 KiB
OCaml
(* This file is free software, part of containers. See file "license" for more details. *)
|
|
|
|
(** Helpers for references
|
|
@since 0.9 *)
|
|
|
|
type 'a printer = Format.formatter -> 'a -> unit
|
|
type 'a ord = 'a -> 'a -> int
|
|
type 'a eq = 'a -> 'a -> bool
|
|
type 'a iter = ('a -> unit) -> unit
|
|
type 'a t = 'a ref
|
|
|
|
val map : ('a -> 'b) -> 'a t -> 'b t
|
|
(** Transform the value. *)
|
|
|
|
val create : 'a -> 'a t
|
|
(** Alias to {!ref}. *)
|
|
|
|
val iter : ('a -> unit) -> 'a t -> unit
|
|
(** Call the function on the content of the reference. *)
|
|
|
|
val update : ('a -> 'a) -> 'a t -> unit
|
|
(** Update the reference's content with the given function. *)
|
|
|
|
val incr_then_get : int t -> int
|
|
(** [incr_then_get r] increments [r] and returns its new value, think [++r].
|
|
@since 0.17 *)
|
|
|
|
val get_then_incr : int t -> int
|
|
(** [get_then_incr r] increments [r] and returns its old value, think [r++].
|
|
@since 0.17 *)
|
|
|
|
val swap : 'a t -> 'a t -> unit
|
|
(** [swap t1 t2] puts [!t2] in [t1] and [!t1] in [t2].
|
|
@since 1.4 *)
|
|
|
|
val protect : 'a t -> 'a -> (unit -> 'b) -> 'b
|
|
(** [protect r x f] sets [r := x]; calls [f()]; restores [r] to its old value;
|
|
and returns the result of [f()].
|
|
@since 3.10 *)
|
|
|
|
val compare : 'a ord -> 'a t ord
|
|
val equal : 'a eq -> 'a t eq
|
|
val to_list : 'a t -> 'a list
|
|
|
|
val to_iter : 'a t -> 'a iter
|
|
(** @since 3.0 *)
|
|
|
|
val pp : 'a printer -> 'a t printer
|