Struct futures_util::lock::MutexGuard

pub struct MutexGuard<'a, T: ?Sized> {
    mutex: &'a Mutex<T>,
}

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.

Fields

mutex: &'a Mutex<T>

Implementations

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

pub fn map<U: ?Sized, F>(this: Self, f: F) -> MappedMutexGuard<'a, T, U>

where 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: ?Sized + Debug> Debug 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.

fn deref(&self) -> &T

Dereferences the value.

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

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

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