Struct r3::sync::mutex::GenericMutexGuard

pub struct GenericMutexGuard<'a, Cell, Mutex: MutexHandle> { /* private fields */ }

Available on crate feature sync only.

An RAII implementation of a “scoped lock” of a mutex. When this structure is dropped, the lock will be released.

This structure is created by the lock and try_lock methods of GenericMutex.

Trait Implementations

impl<Cell, Mutex, T: Debug> Debug for GenericMutexGuard<'_, Cell, Mutex>where
    Cell: Deref<Target = UnsafeCell<MaybeUninit<T>>>,
    Mutex: MutexHandle,

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

Formats the value using the given formatter.

impl<Cell, Mutex, T> Deref for GenericMutexGuard<'_, Cell, Mutex>where
    Cell: Deref<Target = UnsafeCell<MaybeUninit<T>>>,
    Mutex: MutexHandle,

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<Cell, Mutex, T> DerefMut for GenericMutexGuard<'_, Cell, Mutex>where
    Cell: Deref<Target = UnsafeCell<MaybeUninit<T>>>,
    Mutex: MutexHandle,

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

Mutably dereferences the value.

impl<Cell, Mutex, T: Display> Display for GenericMutexGuard<'_, Cell, Mutex>where
    Cell: Deref<Target = UnsafeCell<MaybeUninit<T>>>,
    Mutex: MutexHandle,

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

Formats the value using the given formatter.

impl<Cell, Mutex> Drop for GenericMutexGuard<'_, Cell, Mutex>where
    Mutex: MutexHandle,

The destructor of GenericMutexGuard that releases the lock. It will panic if CPU Lock is active.

fn drop(&mut self)

Executes the destructor for this type.

impl<Cell, Mutex, T> StableDeref for GenericMutexGuard<'_, Cell, Mutex>where
    Cell: Deref<Target = UnsafeCell<MaybeUninit<T>>>,
    Mutex: MutexHandle,

impl<Cell, Mutex, T: Sync> Sync for GenericMutexGuard<'_, Cell, Mutex>where
    Cell: Deref<Target = UnsafeCell<MaybeUninit<T>>>,
    Mutex: MutexHandle,