package batteries
Install
dune-project
Dependency
Authors
Maintainers
Sources
md5=b7f3b99f12f21b1da6b6aa13d993206d
sha512=8b7f2479eb0271bcfd9168887c1e4a9a815c512eab3ee61b150fc4dfa9ec803e4f73115155f20b3017e4a822148d0e6d1c1e8e5f96790fd691b419dd39a908a2
doc/batteries.unthreaded/BatGlobal/index.html
Module BatGlobal
Source
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.
Abstract type of a global
Raised when a global variable is accessed without first having been assigned a value. The parameter contains the name of the global.
Returns 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.
Get the global value contents - raise Global_not_initialized if not defined.
Return None
if the global is undefined, else Some v
where v
is the current global value contents.