Struct tokio::sync::MappedMutexGuard[−][src]

#[must_use = "if unused the Mutex will immediately unlock"]
pub struct MappedMutexGuard<'a, T: ?Sized> { /* fields omitted */ }
This is supported on crate feature sync only.
Expand description

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

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

Implementations

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

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

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

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

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

pub fn try_map<U, F>(this: Self, f: F) -> Result<MappedMutexGuard<'a, U>, Self> where
    F: FnOnce(&mut T) -> Option<&mut U>, [src]

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

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

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

Trait Implementations

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

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

Formats the value using the given formatter. Read more

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target[src]

Dereferences the value.

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

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

Mutably dereferences the value.

impl<'a, T: ?Sized + Display> Display for MappedMutexGuard<'a, T>[src]

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

Formats the value using the given formatter. Read more

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

fn drop(&mut self)[src]

Executes the destructor for this type. Read more

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

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

Auto Trait Implementations

impl<'a, T> !RefUnwindSafe for MappedMutexGuard<'a, T>

impl<'a, T: ?Sized> Unpin for MappedMutexGuard<'a, T>

impl<'a, T> !UnwindSafe for MappedMutexGuard<'a, T>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

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

pub fn from(t: T) -> T[src]

Performs the conversion.

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToString for T where
    T: Display + ?Sized, [src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

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.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

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.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.