Struct LockMut 

pub struct LockMut<T>(/* private fields */);

This datatype provides a lock with interior mutability for the data inside.

Implementations

impl<T> LockMut<T>

pub const fn new() -> Self

Create a new empty LockMut.

Examples

static LOCKED_DATA: LockMut<u8> = LockMut::new();

pub fn init(&self, val: T)

Initialize a previously-uninitialized LockMut.

Examples

static LOCKED_DATA: LockMut<u8> = LockMut::new();
LOCKED_DATA.init(5);

Panics

Panics if this LockMut is to be initialized a second time.

pub fn with_lock<F: FnOnce(&mut T)>(&self, f: F)

Locks, then runs the closure f with a mutable reference to the locked data.

Examples

static LOCKED_DATA: LockMut<u8> = LockMut::new();
LOCKED_DATA.init(5);
LOCKED_DATA.with_lock(|u| *u += 1);

Panics

Panics if this LockMut is uninitialized.

pub fn try_with_lock<F: FnOnce(&mut T)>(&self, f: F)

Locks if this LockMut is initialized, then runs the closure f with a mutable reference to the locked data. If the LockMut is uninitialized, this method does nothing.

Examples

static LOCKED_DATA: LockMut<u8> = LockMut::new();
LOCKED_DATA.try_with_lock(|_| panic!());

Trait Implementations

impl<T: Debug> Debug for LockMut<T>

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

Formats the value using the given formatter.