Struct lock_api::ArcRwLockWriteGuard

pub struct ArcRwLockWriteGuard<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 RwLockWriteGuard 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> ArcRwLockWriteGuard<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 equivalent to the unlocked method on RwLockWriteGuard.

impl<R: RawRwLockDowngrade, T: ?Sized> ArcRwLockWriteGuard<R, T>

pub fn downgrade(s: Self) -> ArcRwLockReadGuard<R, T>

Atomically downgrades a write lock into a read lock without allowing any writers to take exclusive access of the lock in the meantime.

This is functionally equivalent to the downgrade method on RwLockWriteGuard.

impl<R: RawRwLockUpgradeDowngrade, T: ?Sized> ArcRwLockWriteGuard<R, T>

pub fn downgrade_to_upgradable(s: Self) -> ArcRwLockUpgradableReadGuard<R, T>

Atomically downgrades a write lock into an upgradable read lock without allowing any writers to take exclusive access of the lock in the meantime.

This is functionally identical to the downgrade_to_upgradable method on RwLockWriteGuard.

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

pub fn unlock_fair(s: Self)

Unlocks the RwLock using a fair unlock protocol.

This is functionally equivalent to the unlock_fair method on RwLockWriteGuard.

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 equivalent to the unlocked_fair method on RwLockWriteGuard.

pub fn bump(s: &mut Self)

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

This method is functionally equivalent to the bump method on RwLockWriteGuard.

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<R: RawRwLock, T: ?Sized> DerefMut for ArcRwLockWriteGuard<R, T>

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

Mutably dereferences the value.

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.