[][src]Struct futures_util::lock::MappedMutexGuard

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

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

Implementations

impl<'a, T: ?Sized, U: ?Sized> MappedMutexGuard<'a, T, U>[src]

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

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

Example

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

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

Trait Implementations

impl<T: ?Sized, U: ?Sized + Debug> Debug for MappedMutexGuard<'_, T, U>[src]

impl<T: ?Sized, U: ?Sized> Deref for MappedMutexGuard<'_, T, U>[src]

type Target = U

The resulting type after dereferencing.

impl<T: ?Sized, U: ?Sized> DerefMut for MappedMutexGuard<'_, T, U>[src]

impl<T: ?Sized, U: ?Sized> Drop for MappedMutexGuard<'_, T, U>[src]

impl<T: ?Sized + Send, U: ?Sized + Send> Send for MappedMutexGuard<'_, T, U>[src]

impl<T: ?Sized + Sync, U: ?Sized + Sync> Sync for MappedMutexGuard<'_, T, U>[src]

Auto Trait Implementations

impl<'a, T, U> !RefUnwindSafe for MappedMutexGuard<'a, T, U>[src]

impl<'a, T: ?Sized, U: ?Sized> Unpin for MappedMutexGuard<'a, T, U>[src]

impl<'a, T, U> !UnwindSafe for MappedMutexGuard<'a, T, U>[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.