Struct lock_api::ArcReentrantMutexGuard

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

An RAII mutex guard returned by the Arc locking operations on ReentrantMutex.

This is similar to the ReentrantMutexGuard struct, except instead of using a reference to unlock the Mutex it uses an Arc<ReentrantMutex>. This has several advantages, most notably that it has an 'static lifetime.

Implementations

impl<R: RawMutex, G: GetThreadId, T: ?Sized> ArcReentrantMutexGuard<R, G, T>

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

Returns a reference to the ReentrantMutex this object is guarding, contained in its Arc.

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 is safe because &mut guarantees that there exist no other references to the data protected by the mutex.

impl<R: RawMutexFair, G: GetThreadId, T: ?Sized> ArcReentrantMutexGuard<R, G, T>

pub fn unlock_fair(s: Self)

Unlocks the mutex using a fair unlock protocol.

This is functionally identical to the unlock_fair method on ReentrantMutexGuard.

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 is functionally identical to the unlocked_fair method on ReentrantMutexGuard.

pub fn bump(s: &mut Self)

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

This is functionally equivalent to the bump method on ReentrantMutexGuard.

Trait Implementations

impl<R: RawMutex, G: GetThreadId, T: ?Sized> Deref for ArcReentrantMutexGuard<R, G, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<R: RawMutex, G: GetThreadId, T: ?Sized> Drop for ArcReentrantMutexGuard<R, G, T>

fn drop(&mut self)

Executes the destructor for this type.