Struct tokio::sync::OwnedMappedMutexGuard

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

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§

source§

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

source

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.

source

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§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

§

type Target = U

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

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

source§

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

Mutably dereferences the value.
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

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

source§

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

Auto Trait Implementations§

§

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

§

impl<T, U = T> !RefUnwindSafe for OwnedMappedMutexGuard<T, U>

§

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

§

impl<T, U = T> !UnwindSafe for OwnedMappedMutexGuard<T, U>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

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

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.