package batteries
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=00f34b9aed4e47f314425b2ca9ceac206f112095a17ea9a7ffa6dac8cfccc492
md5=066051f9a210277710c54ad57c3b9568
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.