Struct sunrise_kernel::sync::mutex::MutexGuard

#[must_use = "if unused the Mutex will immediately unlock"]pub struct MutexGuard<'a, T: 'a> {
    __lock: &'a Mutex<T>,
    __phantom: PhantomData<*mut ()>,
}

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.

Fields

__lock: &'a Mutex<T>

Reference to the Mutex we'll unlock when dropped.

__phantom: PhantomData<*mut ()>

Raw pointer just to make MutexGuard !Send.

Implementations

impl<'mutex, T> MutexGuard<'mutex, T>

unsafe fn new(lock: &'mutex Mutex<T>) -> MutexGuard<'mutex, T>

Create an MutexGuard.

Safety

Must only be called once we are ensured we are holing the lock, as it will unlock it when dropped

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Mutably dereferences the value.

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

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