package batteries
Install
Dune Dependency
Authors
Maintainers
Sources
md5=66b6e0b25769fc2363972c6a6ab6ac33
sha256=584d314cbaa5485e26d08ce87f7d7ff49043d9096101f2641b59def9aa6d7d71
doc/batteries.unthreaded/BatGlobal/index.html
Module BatGlobal
Mutable global variable.
Often in OCaml you want to have a global variable, which is mutable and uninitialized when declared. You can use a 'a option ref but this is not very convenient. The Global module provides functions to easily create and manipulate such variables.
Raised when a global variable is accessed without first having been assigned a value. The parameter contains the name of the global.
val empty : string -> 'a tReturns an new named empty global. The name of the global can be any string. It identifies the global and makes debugging easier. Using the same string twice will not return the same global twice, but will create two globals with the same name.
val name : 'a t -> stringRetrieve the name of a global.
val set : 'a t -> 'a -> unitSet the global value contents.
val get_exn : 'a t -> 'aGet the global value contents - raise Global_not_initialized if not defined.
val get : 'a t -> 'a optionReturn None if the global is undefined, else Some v where v is the current global value contents.
val undef : 'a t -> unitReset the global value contents to undefined.
val isdef : 'a t -> boolReturn true if the global value has been set.