Struct global::Global

pub struct Global<T> { /* private fields */ }

A global value.

All types wrapped in Global must implement Default. This gives the initial value of the global variable.

Handles to this value can be obtained with the Global::lock or Global::lock_mut methods.

Implementations

impl<T: Default + Send + 'static> Global<T>

pub const INIT: Global<T> = _

The initial global value.

The docs here will show you the internals of Global::INIT, however this is not intended to be visible. Once const fn is stabilized, this will become a const fn.

pub fn new() -> Self

A non-constant version of Global::INIT.

Prefer the constant value where possible.

pub fn with<F, R>(&self, f: F) -> Rwhere
    F: FnOnce(&T) -> R,

Run a closure on an immutable reference to the inner value.

This will return the closure’s return type. Internally, lock is called and unwrapped.

Panics

This will panic if the value is already borrowed mutably in the same thread.

pub fn with_mut<F, R>(&self, f: F) -> Rwhere
    F: FnOnce(&mut T) -> R,

Run a closure on a mutable reference to the inner value.

This will return the closure’s return type. Internally, lock_mut is called and unwrapped.

Panics

This will panic if the value is already borrowed either mutably or immutably in the same thread.

pub fn lock(&self) -> Result<GlobalGuard<T>, BorrowFail>

Obtain a lock providing an immutable reference to the inner value0.

This method will block the current thread until any other threads holding a lock are destroyed. If the current thread already has mutable access, this method will return an error.

pub fn lock_mut(&self) -> Result<GlobalGuardMut<T>, BorrowFail>

Obtain a lock providing a mutable reference to the inner value0.

This method will block the current thread until any other threads holding a lock are destroyed. If the current thread already has access, whether mutable or immutable, this method will return an error.

Trait Implementations

impl<T> Sync for Global<T>where
    T: Send,