Struct MutexGuard 

pub struct MutexGuard<'a, T: ?Sized> { /* private fields */ }

Exclusive access to a Mutex’s value; unlocks on drop.

The release is one atomic read-modify-write when no waiter needs telling. Otherwise it is lock-free, not wait-free: it returns after one pass over the queue, plus at most one for each operation of another thread that lands on the queue meanwhile (see Progress).

Implementations

impl<'a, T: ?Sized> MutexGuard<'a, T>

pub fn map<U, F>(this: Self, f: F) -> MappedMutexGuard<'a, U>

where U: ?Sized, F: FnOnce(&mut T) -> &mut U,

A guard for a component of the locked data. It cannot fail: this guard already holds the lock.

An associated function, MutexGuard::map(guard, f): a method would shadow methods of the locked data.

pub fn try_map<U, F>(this: Self, f: F) -> Result<MappedMutexGuard<'a, U>, Self>

where U: ?Sized, F: FnOnce(&mut T) -> Option<&mut U>,

map that gives the guard back when f finds no component, with the lock still held.

pub fn mutex(this: &Self) -> &'a Mutex<T>

The mutex this guard locks, for a caller that wants to unlock and lock again.

Trait Implementations

impl<T: ?Sized + Debug> Debug for MutexGuard<'_, T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for MutexGuard<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: ?Sized> DerefMut for MutexGuard<'_, T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: ?Sized + Display> Display for MutexGuard<'_, T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Drop for MutexGuard<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.