Struct Mutex 

pub struct Mutex<T: ?Sized> { /* private fields */ }

A mutual exclusion lock that this module’s condvars can wait on.

It wraps std’s mutex, keeping its locking and poisoning.

Implementations

impl<T> Mutex<T>

pub const fn new(value: T) -> Self

Available on not (loom).

Creates an unlocked mutex holding value.

pub fn into_inner(self) -> LockResult<T>

Consumes the mutex and returns its value, inside an error if the mutex is poisoned.

impl<T: ?Sized> Mutex<T>

pub fn lock(&self) -> LockResult<MutexGuard<'_, T>>

Blocks until the mutex is free, then locks it.

If a thread panicked while holding the mutex, the guard comes back inside an error.

pub fn try_lock(&self) -> TryLockResult<MutexGuard<'_, T>>

Locks the mutex if it is free, without blocking.

Fails with WouldBlock while the mutex is locked. If a thread panicked while holding the mutex, the guard comes back inside Poisoned.

pub fn is_poisoned(&self) -> bool

Available on not (loom).

Reports whether a thread panicked while holding the mutex.

pub fn clear_poison(&self)

Available on not (loom).

Clears the poisoned state, marking the value as recovered.

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

Borrows the value mutably, inside an error if the mutex is poisoned.

The mutable borrow of the mutex rules out other users, so this takes no lock.

Trait Implementations

impl<T: ?Sized + Debug> Debug for Mutex<T>

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

Shows the value if the mutex is free, never blocking, as std does.

impl<T: Default> Default for Mutex<T>

fn default() -> Self

Creates an unlocked mutex holding the value type’s default.

impl<T> From<T> for Mutex<T>

fn from(value: T) -> Self

Creates an unlocked mutex holding value.