Struct lock_api::MappedReentrantMutexGuard

source ·
pub struct MappedReentrantMutexGuard<'a, R: RawMutex, G: GetThreadId, T: ?Sized> { /* private fields */ }
Available on crate feature atomic_usize only.
Expand description

An RAII mutex guard returned by ReentrantMutexGuard::map, which can point to a subfield of the protected data.

The main difference between MappedReentrantMutexGuard and ReentrantMutexGuard is that the former doesn’t support temporarily unlocking and re-locking, since that could introduce soundness issues if the locked object is modified by another thread.

Implementations§

source§

impl<'a, R: RawMutex + 'a, G: GetThreadId + 'a, T: ?Sized + 'a> MappedReentrantMutexGuard<'a, R, G, T>

source

pub fn map<U: ?Sized, F>( s: Self, f: F, ) -> MappedReentrantMutexGuard<'a, R, G, U>
where F: FnOnce(&T) -> &U,

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

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

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

source

pub fn try_map<U: ?Sized, F>( s: Self, f: F, ) -> Result<MappedReentrantMutexGuard<'a, R, G, U>, Self>
where F: FnOnce(&T) -> Option<&U>,

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

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

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

source§

impl<'a, R: RawMutexFair + 'a, G: GetThreadId + 'a, T: ?Sized + 'a> MappedReentrantMutexGuard<'a, R, G, T>

source

pub fn unlock_fair(s: Self)

Unlocks the mutex using a fair unlock protocol.

By default, mutexes are unfair and allow the current thread to re-lock the mutex before another has the chance to acquire the lock, even if that thread has been blocked on the mutex for a long time. This is the default because it allows much higher throughput as it avoids forcing a context switch on every mutex unlock. This can result in one thread acquiring a mutex many more times than other threads.

However in some cases it can be beneficial to ensure fairness by forcing the lock to pass on to a waiting thread if there is one. This is done by using this method instead of dropping the ReentrantMutexGuard normally.

Trait Implementations§

source§

impl<'a, R: RawMutex + 'a, G: GetThreadId + 'a, T: Debug + ?Sized + 'a> Debug for MappedReentrantMutexGuard<'a, R, G, T>

source§

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

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

impl<'a, R: RawMutex + 'a, G: GetThreadId + 'a, T: ?Sized + 'a> Deref for MappedReentrantMutexGuard<'a, R, G, T>

§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
source§

impl<'a, R: RawMutex + 'a, G: GetThreadId + 'a, T: Display + ?Sized + 'a> Display for MappedReentrantMutexGuard<'a, R, G, T>

source§

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

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

impl<'a, R: RawMutex + 'a, G: GetThreadId + 'a, T: ?Sized + 'a> Drop for MappedReentrantMutexGuard<'a, R, G, T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<'a, R: RawMutex + Sync + 'a, G: GetThreadId + Sync + 'a, T: ?Sized + Sync + 'a> Sync for MappedReentrantMutexGuard<'a, R, G, T>

Auto Trait Implementations§

§

impl<'a, R, G, T> Freeze for MappedReentrantMutexGuard<'a, R, G, T>
where T: ?Sized,

§

impl<'a, R, G, T> !RefUnwindSafe for MappedReentrantMutexGuard<'a, R, G, T>

§

impl<'a, R, G, T> !Send for MappedReentrantMutexGuard<'a, R, G, T>

§

impl<'a, R, G, T> Unpin for MappedReentrantMutexGuard<'a, R, G, T>
where T: ?Sized,

§

impl<'a, R, G, T> !UnwindSafe for MappedReentrantMutexGuard<'a, R, G, T>

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