Struct ReentrantMutexGuard 

pub struct ReentrantMutexGuard<'a, R: RawMutex, G: GetThreadId, T: ?Sized> { /* private fields */ }

An RAII guard which releases one level of recursive locking when dropped.

The data protected by the mutex can be accessed through this guard via its Deref implementation.

This structure is created by the lock and try_lock methods on ReentrantMutex.

Mutability

Unlike MutexGuard, ReentrantMutexGuard does not implement DerefMut, because doing so would violate Rust’s reference aliasing rules when multiple guards exist on one thread. Use interior mutability, such as Cell or RefCell, to mutate the guarded data.

Implementations

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

pub fn remutex(s: &Self) -> &'a ReentrantMutex<R, G, T>

Returns a reference to the original ReentrantMutex object.

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 is an associated function that needs to be used as ReentrantMutexGuard::map(...). A method would interfere with methods of the same name on the contents of the locked data.

Panics

If f panics, the original guard is dropped.

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 returned if the closure returns None.

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

Panics

If f panics, the original guard is dropped.

pub fn try_map_or_err<U: ?Sized, F, E>( s: Self, f: F, ) -> Result<MappedReentrantMutexGuard<'a, R, G, U>, (Self, E)>

where F: FnOnce(&T) -> Result<&U, E>,

Attempts to make a new MappedReentrantMutexGuard for a component of the locked data. The original guard is returned alongside arbitrary user data if the closure returns Err.

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

Panics

If f panics, the original guard is dropped.

pub fn unlocked<F, U>(s: &mut Self, f: F) -> U

where F: FnOnce() -> U,

Temporarily unlocks the mutex to execute the given function.

This releases only one level of recursive locking. The underlying mutex remains locked if the current thread has acquired it more than once.

Aborts

Aborts if re-locking the mutex panics.

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

pub fn unlock_fair(s: Self)

Releases one level of recursive locking. A fair unlock is performed only if this releases the final level.

pub fn unlocked_fair<F, U>(s: &mut Self, f: F) -> U

where F: FnOnce() -> U,

Temporarily unlocks the mutex to execute the given function.

This releases only one level of recursive locking. A fair unlock is performed only if this releases the final level.

Aborts

Aborts if re-locking the mutex panics.

pub fn bump(s: &mut Self)

Temporarily yields the mutex to a waiting thread if there is one.

This method is functionally equivalent to calling unlock_fair followed by lock, however it can be much more efficient in the case where there are no waiting threads.

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

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.