Struct MutexGuard

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

An RAII implementation of a “scoped lock” of a mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.

The data protected by the mutex can be accessed through this guard via its Deref and DerefMut implementations.

This structure is created by the lock and try_lock methods on Mutex.

Trait Implementations

impl<T, Lock, R: ?Sized> AsMut<R> for MutexGuard<'_, T, Lock>

where T: AsMut<R>, Lock: RawMutex,

fn as_mut(&mut self) -> &mut R

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T, Lock, R: ?Sized> AsRef<R> for MutexGuard<'_, T, Lock>

where T: AsRef<R>, Lock: RawMutex,

fn as_ref(&self) -> &R

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, Lock> Debug for MutexGuard<'_, T, Lock>

where T: Debug, Lock: RawMutex,

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

Formats the value using the given formatter.

impl<T, Lock: RawMutex> Deref for MutexGuard<'_, T, Lock>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, Lock: RawMutex> DerefMut for MutexGuard<'_, T, Lock>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T, Lock> Display for MutexGuard<'_, T, Lock>

where T: Display, Lock: RawMutex,

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

Formats the value using the given formatter.

impl<T, Lock> Drop for MutexGuard<'_, T, Lock>

where Lock: RawMutex,

fn drop(&mut self)

Executes the destructor for this type.

impl<T, Lock> Send for MutexGuard<'_, T, Lock>

where T: Send, Lock: RawMutex + Sync, Lock::GuardMarker: Send,

A MutexGuard is only Send if:

1. the protected data (T) is Send, because the guard may be used to mutably access the protected data, and can therefore be used to move it using core::mem::replace or similar.
2. the Lock type parameter is Sync, because the guard contains a reference to the Lock type, and therefore, sending the guard is sharing a reference to the Lock.
3. the Lock type’s RawMutex::GuardMarker associated type is Send, because this indicates that the Lock type agrees that guards may be Send.