package batteries

  1. Overview
  2. Docs
A community-maintained standard library extension

Install 

dune-project
 Dependency

batteries.forge.ocamlcore.org Edit opam file Versions (15)

Authors

  1. O
    OCaml batteries-included team

Maintainers

  1. C
    Cedric Cellier <rixed@happyleptic.org>
  2. F
    Francois Berenger <unixjunkie@sdf.org>
  3. Gabriel Scherer
  4. T
    Thibault Suzanne <thi.suzanne@gmail.com>

Sources

v3.2.0.tar.gz
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.

  • author Nicolas Cannasse
  • author David Teller (boilerplate code)
type 'a t

Abstract type of a global

exception Global_not_initialized of string

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 t

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.

val name : 'a t -> string

Retrieve the name of a global.

val set : 'a t -> 'a -> unit

Set the global value contents.

val get_exn : 'a t -> 'a

Get the global value contents - raise Global_not_initialized if not defined.

val get : 'a t -> 'a option

Return None if the global is undefined, else Some v where v is the current global value contents.

val undef : 'a t -> unit

Reset the global value contents to undefined.

val isdef : 'a t -> bool

Return true if the global value has been set.