package core

  1. Overview
  2. Docs
Industrial strength alternative to OCaml's standard library

Install

Dune Dependency

Authors

Maintainers

Sources

v0.17.1.tar.gz
md5=743a141234e04210e295980f7a78a6d9
sha512=61b415f4fb12c78d30649fff1aabe3a475eea926ce6edb7774031f4dc7f37ea51f5d9337ead6ec73cd93da5fd1ed0f2738c210c71ebc8fe9d7f6135a06bd176f

doc/core/Core/Set_once/index.html

Module Core.Set_onceSource

A 'a Set_once.t is like an 'a option ref that can only be set once. A Set_once.t starts out as None, the first set transitions it to Some, and subsequent sets fail.

Equality is determined only by the internal value and not the source code position of where the value was set.

Sourcetype 'a t
include Ppx_compare_lib.Comparable.S1 with type 'a t := 'a t
Sourceval compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
include Ppx_compare_lib.Equal.S1 with type 'a t := 'a t
Sourceval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t

Passes when unset.

include Base.Invariant.S1 with type 'a t := 'a t
Sourceval invariant : ('a -> unit) -> 'a t -> unit
Sourceval create : Base.Unit.t -> _ t
Sourceval set_exn : 'a t -> Source_code_position.t -> 'a -> Base.Unit.t
Sourceval set_if_none : 'a t -> Source_code_position.t -> 'a -> Base.Unit.t

set_if_none t here a will do nothing if is_some t, otherwise it will set_exn t here a.

Sourceval get : 'a t -> 'a Base.Option.t
Sourceval get_exn : 'a t -> Source_code_position.t -> 'a
Sourceval is_none : _ t -> Base.Bool.t
Sourceval is_some : _ t -> Base.Bool.t
Sourceval iter : 'a t -> f:('a -> Base.Unit.t) -> Base.Unit.t
Sourcemodule Optional_syntax : Optional_syntax.S1 with type 'a t := 'a t with type 'a value := 'a
Sourcemodule Unstable : sig ... end
Sourcemodule Stable : sig ... end
OCaml

Innovation. Community. Security.