Struct maitake_sync::mutex::MutexGuard

pub struct MutexGuard<'a, T: ?Sized, L: ScopedRawMutex = DefaultMutex> { /* 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 guard can be held across any .await point, as it implements Send.

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

Trait Implementations

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

where T: ?Sized + Debug, L: ScopedRawMutex,

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

Formats the value using the given formatter.

impl<T, L> Deref for MutexGuard<'_, T, L>

where T: ?Sized, L: ScopedRawMutex,

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, L> DerefMut for MutexGuard<'_, T, L>

where T: ?Sized, L: ScopedRawMutex,

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

Mutably dereferences the value.

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

where T: ?Sized + Send, L: ScopedRawMutex + Sync,

impl<T, L> Sync for MutexGuard<'_, T, L>

where T: ?Sized + Send + Sync, L: ScopedRawMutex + Sync,