Struct lock_api::ArcRwLockReadGuard

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

Available on crate feature arc_lock only.

An RAII rwlock guard returned by the Arc locking operations on RwLock.

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

Implementations

impl<R: RawRwLock, T: ?Sized> ArcRwLockReadGuard<R, T>

pub fn rwlock(s: &Self) -> &Arc<RwLock<R, T>>

Returns a reference to the rwlock, contained in its Arc.

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

where F: FnOnce() -> U,

Temporarily unlocks the RwLock to execute the given function.

This is functionally identical to the unlocked method on RwLockReadGuard.

impl<R: RawRwLockFair, T: ?Sized> ArcRwLockReadGuard<R, T>

pub fn unlock_fair(s: Self)

Unlocks the RwLock using a fair unlock protocol.

This is functionally identical to the unlock_fair method on RwLockReadGuard.

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

where F: FnOnce() -> U,

Temporarily unlocks the RwLock to execute the given function.

This is functionally identical to the unlocked_fair method on RwLockReadGuard.

pub fn bump(s: &mut Self)

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

This is functionally identical to the bump method on RwLockReadGuard.

Trait Implementations

impl<R: RawRwLock, T: Debug + ?Sized> Debug for ArcRwLockReadGuard<R, T>

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

Formats the value using the given formatter.

impl<R: RawRwLock, T: ?Sized> Deref for ArcRwLockReadGuard<R, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<R: RawRwLock, T: Display + ?Sized> Display for ArcRwLockReadGuard<R, T>

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

Formats the value using the given formatter.

impl<R: RawRwLock, T: ?Sized> Drop for ArcRwLockReadGuard<R, T>

fn drop(&mut self)

Executes the destructor for this type.