Struct GlobalMut

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

A cell to store mutable reference.

Safety

Because the implementation internally converts raw pointers to usize and shares them between threads, fetching references is essentially unsafe. Please verify its safety before using it.

Implementations

impl<T> GlobalMut<T>

pub const fn new() -> Self

Create a new instance.

pub unsafe fn set(&self, item: &mut T)

Set a reference so that other functions can obtain it through GlobalMut. It is recommended to use with() instead. Be sure to call clear() after it is used.

pub fn clear(&self)

Clear the registered reference.

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

where F: FnOnce() -> R,

Set a reference and clear the reference after calling the given closure.

pub fn get(&self) -> &T

Get a immutable reference. Panics if set() or with() has not been called before.

pub fn try_get(&self) -> Option<&T>

Get a immutable reference. Returns None if set() or with() has not been called before.

pub fn get_mut(&self) -> &mut T

Get a mutable reference. Panics if set() or with() has not been called before.

pub fn try_get_mut(&self) -> Option<&mut T>

Get a mutable reference. Returns None if set() or with() has not been called before.

Trait Implementations

impl<T: Debug> Debug for GlobalMut<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Default for GlobalMut<T>

fn default() -> Self

Returns the “default value” for a type.