Struct lock_api::ArcMutexGuard

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

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§

source§

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

source

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

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

source

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

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

source

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.

source§

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

source

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.

source

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.

source

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§

source§

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

§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
source§

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

source§

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

Mutably dereferences the value.
source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

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

source§

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

Auto Trait Implementations§

§

impl<R, T> Freeze for ArcMutexGuard<R, T>
where T: ?Sized,

§

impl<R, T> !RefUnwindSafe for ArcMutexGuard<R, T>

§

impl<R, T> Unpin for ArcMutexGuard<R, T>
where T: ?Sized,

§

impl<R, T> !UnwindSafe for ArcMutexGuard<R, 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.