Struct maitake_sync::mutex::OwnedMutexGuard

pub struct OwnedMutexGuard<T: ?Sized, L: ScopedRawMutex> { /* private fields */ }

Available on crate feature alloc only.

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

This type is similar to the MutexGuard type, but it is only returned by a Mutex that is wrapped in an an Arc. Instead of borrowing the Mutex, this guard holds an Arc clone of the Mutex, incrementing its reference count. Therefore, this type can outlive the Mutex that created it, and it is valid for the 'static lifetime.

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_owned and try_lock_owned methods on Mutex.

Trait Implementations

impl<T, L> Debug for OwnedMutexGuard<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 OwnedMutexGuard<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 OwnedMutexGuard<T, L>

where T: ?Sized, L: ScopedRawMutex,

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

Mutably dereferences the value.

impl<T, L> Send for OwnedMutexGuard<T, L>

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

impl<T, L> Sync for OwnedMutexGuard<T, L>

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