Struct ArcRwLockReadGuard

pub struct ArcRwLockReadGuard<R, T>
where
    R: RawRwLock,
    T: ?Sized,
{
    rwlock: Arc<RwLock<R, T>>,
    marker: PhantomData<<R as RawRwLock>::GuardMarker>,
}

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.

Fields

rwlock: Arc<RwLock<R, T>>

marker: PhantomData<<R as RawRwLock>::GuardMarker>

Implementations

impl<R, T> ArcRwLockReadGuard<R, T>

where R: RawRwLock, T: ?Sized,

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

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

pub fn unlocked<F, U>(s: &mut ArcRwLockReadGuard<R, T>, 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, T> ArcRwLockReadGuard<R, T>

where R: RawRwLockFair, T: ?Sized,

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

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 ArcRwLockReadGuard<R, T>, 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 ArcRwLockReadGuard<R, T>)

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, T> Debug for ArcRwLockReadGuard<R, T>

where R: RawRwLock, T: Debug + ?Sized,

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

Formats the value using the given formatter.

impl<R, T> Deref for ArcRwLockReadGuard<R, T>

where R: RawRwLock, T: ?Sized,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<R, T> Display for ArcRwLockReadGuard<R, T>

where R: RawRwLock, T: Display + ?Sized,

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

Formats the value using the given formatter.

impl<R, T> Drop for ArcRwLockReadGuard<R, T>

where R: RawRwLock, T: ?Sized,

fn drop(&mut self)

Executes the destructor for this type.