Struct lock_api::ArcMutexGuard

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

Available on crate feature arc_lock only.

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

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

Implementations

impl<R: RawMutex, T: ?Sized> ArcMutexGuard<R, T>

pub fn mutex(s: &Self) -> &Arc<Mutex<R, T>>

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

pub fn into_arc(s: Self) -> Arc<Mutex<R, T>>

Unlocks the mutex and returns the Arc that was held by the ArcMutexGuard.

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, T: ?Sized> ArcMutexGuard<R, 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 MutexGuard.

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

pub fn bump(s: &mut Self)

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

This is functionally identical to the bump method on MutexGuard.

Trait Implementations

impl<R: RawMutex, T: ?Sized> Deref for ArcMutexGuard<R, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<R: RawMutex, T: ?Sized> DerefMut for ArcMutexGuard<R, T>

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

Mutably dereferences the value.

impl<R: RawMutex, T: ?Sized> Drop for ArcMutexGuard<R, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<R: RawMutex + Send + Sync, T: Send + ?Sized> Send for ArcMutexGuard<R, T>

where R::GuardMarker: Send,

impl<R: RawMutex + Sync, T: Sync + ?Sized> Sync for ArcMutexGuard<R, T>

where R::GuardMarker: Sync,