Struct futures::lock::MutexGuard

pub struct MutexGuard<'a, T> where
    T: ?Sized,  { /* fields omitted */ }

An RAII guard returned by the lock and try_lock methods. When this structure is dropped (falls out of scope), the lock will be unlocked.

Implementations

impl<'a, T> MutexGuard<'a, T> where
    T: ?Sized, 

pub fn map<U, F>(this: MutexGuard<'a, T>, f: F) -> MappedMutexGuard<'a, T, U> where
    U: ?Sized,
    F: FnOnce(&mut T) -> &mut U, 

Returns a locked view over a portion of the locked data.

Example

use futures::lock::{Mutex, MutexGuard};

let data = Mutex::new(Some("value".to_string()));
{
    let locked_str = MutexGuard::map(data.lock().await, |opt| opt.as_mut().unwrap());
    assert_eq!(&*locked_str, "value");
}

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

pub fn deref(&self) -> &T

Dereferences the value.

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

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

Mutably dereferences the value.

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

pub fn drop(&mut self)

Executes the destructor for this type.

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

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