Struct std::sync::MutexGuard

#[must_use = "if unused the Mutex will immediately unlock"]
pub struct MutexGuard<'a, T: ?Sized + 'a> { /* 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: ?Sized + Debug, '_> Debug for MutexGuard<'_, T>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

Important traits for &'_ mut F

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

fn deref(&self) -> &T

Dereferences the value.

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

Important traits for &'_ mut F

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

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

Mutably dereferences the value.

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

fn drop(&mut self)

Executes the destructor for this type.

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

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