Struct std::sync::MutexGuard

#[must_use = "if unused the Mutex will immediately unlock"]
pub struct MutexGuard<'a, T> where
    T: 'a + ?Sized,  { /* fields omitted */ }

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.

Trait Implementations

impl<'_, T> Deref for MutexGuard<'_, T> where
    T: ?Sized, 

type Target = T

The resulting type after dereferencing.

Important traits for &'_ mut W

impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

fn deref(&self) -> &T

Dereferences the value.

impl<'_, T> Debug for MutexGuard<'_, T> where
    T: Debug + ?Sized, 

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

Formats the value using the given formatter.

impl<'_, T> Sync for MutexGuard<'_, T> where
    T: Sync + ?Sized, 

impl<'_, T> Drop for MutexGuard<'_, T> where
    T: ?Sized, 

fn drop(&mut self)

Executes the destructor for this type.

impl<'_, T> !Send for MutexGuard<'_, T> where
    T: ?Sized, 

impl<'_, T> Display for MutexGuard<'_, T> where
    T: Display + ?Sized, 

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

Formats the value using the given formatter.

impl<'_, T> DerefMut for MutexGuard<'_, T> where
    T: ?Sized, 

Important traits for &'_ mut W

impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

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

Mutably dereferences the value.