Struct parking_lot::ArcReentrantMutexGuard

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

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§

source§

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

source

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

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

source

pub fn unlocked<F, U>(s: &mut ArcReentrantMutexGuard<R, G, T>, 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, G, T> ArcReentrantMutexGuard<R, G, T>
where R: RawMutexFair, G: GetThreadId, T: ?Sized,

source

pub fn unlock_fair(s: ArcReentrantMutexGuard<R, G, T>)

Unlocks the mutex using a fair unlock protocol.

This is functionally identical to the unlock_fair method on ReentrantMutexGuard.

source

pub fn unlocked_fair<F, U>(s: &mut ArcReentrantMutexGuard<R, G, T>, 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.

source

pub fn bump(s: &mut ArcReentrantMutexGuard<R, G, T>)

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

This is functionally equivalent to the bump method on ReentrantMutexGuard.

Trait Implementations§

source§

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

§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

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

§

impl<R, G, T> !RefUnwindSafe for ArcReentrantMutexGuard<R, G, T>

§

impl<R, G, T> !Send for ArcReentrantMutexGuard<R, G, T>

§

impl<R, G, T> Sync for ArcReentrantMutexGuard<R, G, T>
where R: Sync + Send, G: Sync + Send, T: Send + ?Sized,

§

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

§

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