Struct std::sync::MutexGuard

[+] Show declaration

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

[−] Expand description

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> Deref for MutexGuard<'_, T>[+]

[+] Show hidden undocumented items

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>[+]

[+] Show hidden undocumented items

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

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

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

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

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

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

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

[+] Show hidden undocumented items

fn drop(&mut self)[−]

Executes the destructor for this type.