Struct tokio::sync::OwnedMappedMutexGuard

pub struct OwnedMappedMutexGuard<T: ?Sized, U: ?Sized = T> { /* private fields */ }

A owned handle to a held Mutex that has had a function applied to it via OwnedMutexGuard::map.

This can be used to hold a subfield of the protected data.

Implementations

impl<T: ?Sized, U: ?Sized> OwnedMappedMutexGuard<T, U>

pub fn map<S, F>(this: Self, f: F) -> OwnedMappedMutexGuard<T, S>where
    F: FnOnce(&mut U) -> &mut S,

Makes a new OwnedMappedMutexGuard for a component of the locked data.

This operation cannot fail as the OwnedMappedMutexGuard passed in already locked the mutex.

This is an associated function that needs to be used as OwnedMappedMutexGuard::map(...). A method would interfere with methods of the same name on the contents of the locked data.

pub fn try_map<S, F>(
    this: Self,
    f: F
) -> Result<OwnedMappedMutexGuard<T, S>, Self>where
    F: FnOnce(&mut U) -> Option<&mut S>,

Attempts to make a new OwnedMappedMutexGuard for a component of the locked data. The original guard is returned if the closure returns None.

This operation cannot fail as the OwnedMutexGuard passed in already locked the mutex.

This is an associated function that needs to be used as OwnedMutexGuard::try_map(...). A method would interfere with methods of the same name on the contents of the locked data.

Trait Implementations

impl<T: ?Sized, U: ?Sized + Debug> Debug for OwnedMappedMutexGuard<T, U>

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

Formats the value using the given formatter.

impl<T: ?Sized, U: ?Sized> Deref for OwnedMappedMutexGuard<T, U>

type Target = U

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: ?Sized, U: ?Sized> DerefMut for OwnedMappedMutexGuard<T, U>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: ?Sized, U: ?Sized + Display> Display for OwnedMappedMutexGuard<T, U>

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

Formats the value using the given formatter.

impl<T: ?Sized, U: ?Sized> Drop for OwnedMappedMutexGuard<T, U>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, U> Send for OwnedMappedMutexGuard<T, U>where
    T: ?Sized + Send,
    U: ?Sized + Send,

impl<T, U> Sync for OwnedMappedMutexGuard<T, U>where
    T: ?Sized + Send + Sync,
    U: ?Sized + Send + Sync,