Struct MutexGuard 

pub struct MutexGuard<'a, T: 'a> {
    t: &'a mut T,
    lock: &'a Mutex<T>,
}

An implementation of a “scoped lock” of a mutex. When this structure is dropped (falls out of scope) without unlocking, the panic occurs.

The lock must be explicitly unlocked by unlock method.

The data protected by the mutex can be accessed through this guard.

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

Fields

t: &'a mut T

lock: &'a Mutex<T>

Implementations

impl<T> MutexGuard<'_, T>

pub fn unlock(self)

Releases the underlying Mutex.

As the guard does not automatically release the lock on drop, the caller must explicitly invoke unlock to mark the lock as available again.

Example

let lock = Mutex::new(123);
let guard = lock.lock();

// Work with the locked data...

// Explicitly release the lock.
guard.unlock();

Trait Implementations

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> Drop for MutexGuard<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

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

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