pub struct ArcRwLockUpgradableReadGuard<R, T>where
R: RawRwLockUpgrade,
T: ?Sized,{ /* private fields */ }
Expand description
An RAII rwlock guard returned by the Arc
locking operations on RwLock
.
This is similar to the RwLockUpgradableReadGuard
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§
source§impl<R, T> ArcRwLockUpgradableReadGuard<R, T>where
R: RawRwLockUpgrade,
T: ?Sized,
impl<R, T> ArcRwLockUpgradableReadGuard<R, T>where
R: RawRwLockUpgrade,
T: ?Sized,
sourcepub fn rwlock(s: &ArcRwLockUpgradableReadGuard<R, T>) -> &Arc<RwLock<R, T>>
pub fn rwlock(s: &ArcRwLockUpgradableReadGuard<R, T>) -> &Arc<RwLock<R, T>>
Returns a reference to the rwlock, contained in its original Arc
.
sourcepub fn unlocked<F, U>(s: &mut ArcRwLockUpgradableReadGuard<R, T>, f: F) -> Uwhere
F: FnOnce() -> U,
pub fn unlocked<F, U>(s: &mut ArcRwLockUpgradableReadGuard<R, T>, f: F) -> Uwhere
F: FnOnce() -> U,
Temporarily unlocks the RwLock
to execute the given function.
This is functionally identical to the unlocked
method on RwLockUpgradableReadGuard
.
sourcepub fn upgrade(
s: ArcRwLockUpgradableReadGuard<R, T>
) -> ArcRwLockWriteGuard<R, T>
pub fn upgrade( s: ArcRwLockUpgradableReadGuard<R, T> ) -> ArcRwLockWriteGuard<R, T>
Atomically upgrades an upgradable read lock lock into an exclusive write lock, blocking the current thread until it can be acquired.
sourcepub fn try_upgrade(
s: ArcRwLockUpgradableReadGuard<R, T>
) -> Result<ArcRwLockWriteGuard<R, T>, ArcRwLockUpgradableReadGuard<R, T>>
pub fn try_upgrade( s: ArcRwLockUpgradableReadGuard<R, T> ) -> Result<ArcRwLockWriteGuard<R, T>, ArcRwLockUpgradableReadGuard<R, T>>
Tries to atomically upgrade an upgradable read lock into an exclusive write lock.
If the access could not be granted at this time, then the current guard is returned.
source§impl<R, T> ArcRwLockUpgradableReadGuard<R, T>where
R: RawRwLockUpgradeFair,
T: ?Sized,
impl<R, T> ArcRwLockUpgradableReadGuard<R, T>where
R: RawRwLockUpgradeFair,
T: ?Sized,
sourcepub fn unlock_fair(s: ArcRwLockUpgradableReadGuard<R, T>)
pub fn unlock_fair(s: ArcRwLockUpgradableReadGuard<R, T>)
Unlocks the RwLock
using a fair unlock protocol.
This is functionally identical to the unlock_fair
method on RwLockUpgradableReadGuard
.
sourcepub fn unlocked_fair<F, U>(
s: &mut ArcRwLockUpgradableReadGuard<R, T>,
f: F
) -> Uwhere
F: FnOnce() -> U,
pub fn unlocked_fair<F, U>(
s: &mut ArcRwLockUpgradableReadGuard<R, T>,
f: F
) -> Uwhere
F: FnOnce() -> U,
Temporarily unlocks the RwLock
to execute the given function.
This is functionally equivalent to the unlocked_fair
method on RwLockUpgradableReadGuard
.
sourcepub fn bump(s: &mut ArcRwLockUpgradableReadGuard<R, T>)
pub fn bump(s: &mut ArcRwLockUpgradableReadGuard<R, T>)
Temporarily yields the RwLock
to a waiting thread if there is one.
This method is functionally equivalent to calling bump
on RwLockUpgradableReadGuard
.
source§impl<R, T> ArcRwLockUpgradableReadGuard<R, T>where
R: RawRwLockUpgradeDowngrade,
T: ?Sized,
impl<R, T> ArcRwLockUpgradableReadGuard<R, T>where
R: RawRwLockUpgradeDowngrade,
T: ?Sized,
sourcepub fn downgrade(
s: ArcRwLockUpgradableReadGuard<R, T>
) -> ArcRwLockReadGuard<R, T>
pub fn downgrade( s: ArcRwLockUpgradableReadGuard<R, T> ) -> ArcRwLockReadGuard<R, T>
Atomically downgrades an upgradable read lock lock into a shared read lock without allowing any writers to take exclusive access of the lock in the meantime.
Note that if there are any writers currently waiting to take the lock then other readers may not be able to acquire the lock even if it was downgraded.
sourcepub fn with_upgraded<Ret, F>(&mut self, f: F) -> Ret
pub fn with_upgraded<Ret, F>(&mut self, f: F) -> Ret
First, atomically upgrades an upgradable read lock lock into an exclusive write lock, blocking the current thread until it can be acquired.
Then, calls the provided closure with an exclusive reference to the lock’s data.
Finally, atomically downgrades the lock back to an upgradable read lock. The closure’s return value is returned.
This function only requires a mutable reference to the guard, unlike
upgrade
which takes the guard by value.
sourcepub fn try_with_upgraded<Ret, F>(&mut self, f: F) -> Option<Ret>
pub fn try_with_upgraded<Ret, F>(&mut self, f: F) -> Option<Ret>
First, tries to atomically upgrade an upgradable read lock into an exclusive write lock.
If the access could not be granted at this time, then None
is returned.
Otherwise, calls the provided closure with an exclusive reference to the lock’s data,
and finally downgrades the lock back to an upgradable read lock.
The closure’s return value is wrapped in Some
and returned.
This function only requires a mutable reference to the guard, unlike
try_upgrade
which takes the guard by value.
source§impl<R, T> ArcRwLockUpgradableReadGuard<R, T>where
R: RawRwLockUpgradeTimed,
T: ?Sized,
impl<R, T> ArcRwLockUpgradableReadGuard<R, T>where
R: RawRwLockUpgradeTimed,
T: ?Sized,
sourcepub fn try_upgrade_for(
s: ArcRwLockUpgradableReadGuard<R, T>,
timeout: <R as RawRwLockTimed>::Duration
) -> Result<ArcRwLockWriteGuard<R, T>, ArcRwLockUpgradableReadGuard<R, T>>
pub fn try_upgrade_for( s: ArcRwLockUpgradableReadGuard<R, T>, timeout: <R as RawRwLockTimed>::Duration ) -> Result<ArcRwLockWriteGuard<R, T>, ArcRwLockUpgradableReadGuard<R, T>>
Tries to atomically upgrade an upgradable read lock into an exclusive write lock, until a timeout is reached.
If the access could not be granted before the timeout expires, then the current guard is returned.
sourcepub fn try_upgrade_until(
s: ArcRwLockUpgradableReadGuard<R, T>,
timeout: <R as RawRwLockTimed>::Instant
) -> Result<ArcRwLockWriteGuard<R, T>, ArcRwLockUpgradableReadGuard<R, T>>
pub fn try_upgrade_until( s: ArcRwLockUpgradableReadGuard<R, T>, timeout: <R as RawRwLockTimed>::Instant ) -> Result<ArcRwLockWriteGuard<R, T>, ArcRwLockUpgradableReadGuard<R, T>>
Tries to atomically upgrade an upgradable read lock into an exclusive write lock, until a timeout is reached.
If the access could not be granted before the timeout expires, then the current guard is returned.
source§impl<R, T> ArcRwLockUpgradableReadGuard<R, T>
impl<R, T> ArcRwLockUpgradableReadGuard<R, T>
sourcepub fn try_with_upgraded_for<Ret, F>(
&mut self,
timeout: <R as RawRwLockTimed>::Duration,
f: F
) -> Option<Ret>
pub fn try_with_upgraded_for<Ret, F>( &mut self, timeout: <R as RawRwLockTimed>::Duration, f: F ) -> Option<Ret>
Tries to atomically upgrade an upgradable read lock into an exclusive write lock, until a timeout is reached.
If the access could not be granted before the timeout expires, then
None
is returned.
Otherwise, calls the provided closure with an exclusive reference to the lock’s data,
and finally downgrades the lock back to an upgradable read lock.
The closure’s return value is wrapped in Some
and returned.
This function only requires a mutable reference to the guard, unlike
try_upgrade_for
which takes the guard by value.
sourcepub fn try_with_upgraded_until<Ret, F>(
&mut self,
timeout: <R as RawRwLockTimed>::Instant,
f: F
) -> Option<Ret>
pub fn try_with_upgraded_until<Ret, F>( &mut self, timeout: <R as RawRwLockTimed>::Instant, f: F ) -> Option<Ret>
Tries to atomically upgrade an upgradable read lock into an exclusive write lock, until a timeout is reached.
If the access could not be granted before the timeout expires, then
None
is returned.
Otherwise, calls the provided closure with an exclusive reference to the lock’s data,
and finally downgrades the lock back to an upgradable read lock.
The closure’s return value is wrapped in Some
and returned.
This function only requires a mutable reference to the guard, unlike
try_upgrade_until
which takes the guard by value.