Struct MappedMutexGuard

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

Available on crate feature sync only.

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>

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

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>,

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>

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

Formats the value using the given formatter. Read more

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

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

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

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

Formats the value using the given formatter. Read more

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

fn drop(&mut self)

Executes the destructor for this type. Read more

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

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

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

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

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct MappedMutexGuard

Implementations

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

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

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

Trait Implementations

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

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

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

type Target = T

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

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

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

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

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

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

fn drop(&mut self)

fn pin_drop(self: Pin<&mut Self>)

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

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

fn into(self) -> U

impl<P, T> Receiver for Pwhere P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

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

fn to_string(&self) -> String

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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

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

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

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

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

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

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

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

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

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

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

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,