Struct lair_keystore::dependencies::parking_lot::lock_api::RwLockReadGuard
source · pub struct RwLockReadGuard<'a, R, T>{ /* private fields */ }
Expand description
RAII structure used to release the shared read access of a lock when dropped.
Implementations§
source§impl<'a, R, T> RwLockReadGuard<'a, R, T>
impl<'a, R, T> RwLockReadGuard<'a, R, T>
sourcepub fn rwlock(s: &RwLockReadGuard<'a, R, T>) -> &'a RwLock<R, T>
pub fn rwlock(s: &RwLockReadGuard<'a, R, T>) -> &'a RwLock<R, T>
Returns a reference to the original reader-writer lock object.
sourcepub fn map<U, F>(
s: RwLockReadGuard<'a, R, T>,
f: F,
) -> MappedRwLockReadGuard<'a, R, U>
pub fn map<U, F>( s: RwLockReadGuard<'a, R, T>, f: F, ) -> MappedRwLockReadGuard<'a, R, U>
Make a new MappedRwLockReadGuard
for a component of the locked data.
This operation cannot fail as the RwLockReadGuard
passed
in already locked the data.
This is an associated function that needs to be
used as RwLockReadGuard::map(...)
. A method would interfere with methods of
the same name on the contents of the locked data.
sourcepub fn try_map<U, F>(
s: RwLockReadGuard<'a, R, T>,
f: F,
) -> Result<MappedRwLockReadGuard<'a, R, U>, RwLockReadGuard<'a, R, T>>
pub fn try_map<U, F>( s: RwLockReadGuard<'a, R, T>, f: F, ) -> Result<MappedRwLockReadGuard<'a, R, U>, RwLockReadGuard<'a, R, T>>
Attempts to make a new MappedRwLockReadGuard
for a component of the
locked data. Returns the original guard if the closure returns None
.
This operation cannot fail as the RwLockReadGuard
passed
in already locked the data.
This is an associated function that needs to be
used as RwLockReadGuard::try_map(...)
. A method would interfere with methods of
the same name on the contents of the locked data.
sourcepub fn unlocked<F, U>(s: &mut RwLockReadGuard<'a, R, T>, f: F) -> Uwhere
F: FnOnce() -> U,
pub fn unlocked<F, U>(s: &mut RwLockReadGuard<'a, R, T>, f: F) -> Uwhere
F: FnOnce() -> U,
Temporarily unlocks the RwLock
to execute the given function.
This is safe because &mut
guarantees that there exist no other
references to the data protected by the RwLock
.
source§impl<'a, R, T> RwLockReadGuard<'a, R, T>where
R: RawRwLockFair + 'a,
T: 'a + ?Sized,
impl<'a, R, T> RwLockReadGuard<'a, R, T>where
R: RawRwLockFair + 'a,
T: 'a + ?Sized,
sourcepub fn unlock_fair(s: RwLockReadGuard<'a, R, T>)
pub fn unlock_fair(s: RwLockReadGuard<'a, R, T>)
Unlocks the RwLock
using a fair unlock protocol.
By default, RwLock
is unfair and allow the current thread to re-lock
the RwLock
before another has the chance to acquire the lock, even if
that thread has been blocked on the RwLock
for a long time. This is
the default because it allows much higher throughput as it avoids
forcing a context switch on every RwLock
unlock. This can result in one
thread acquiring a RwLock
many more times than other threads.
However in some cases it can be beneficial to ensure fairness by forcing
the lock to pass on to a waiting thread if there is one. This is done by
using this method instead of dropping the RwLockReadGuard
normally.
sourcepub fn unlocked_fair<F, U>(s: &mut RwLockReadGuard<'a, R, T>, f: F) -> Uwhere
F: FnOnce() -> U,
pub fn unlocked_fair<F, U>(s: &mut RwLockReadGuard<'a, R, T>, f: F) -> Uwhere
F: FnOnce() -> U,
Temporarily unlocks the RwLock
to execute the given function.
The RwLock
is unlocked a fair unlock protocol.
This is safe because &mut
guarantees that there exist no other
references to the data protected by the RwLock
.
sourcepub fn bump(s: &mut RwLockReadGuard<'a, R, T>)
pub fn bump(s: &mut RwLockReadGuard<'a, R, T>)
Temporarily yields the RwLock
to a waiting thread if there is one.
This method is functionally equivalent to calling unlock_fair
followed
by read
, however it can be much more efficient in the case where there
are no waiting threads.
Trait Implementations§
source§impl<'a, R, T> Debug for RwLockReadGuard<'a, R, T>
impl<'a, R, T> Debug for RwLockReadGuard<'a, R, T>
source§impl<'a, R, T> Deref for RwLockReadGuard<'a, R, T>
impl<'a, R, T> Deref for RwLockReadGuard<'a, R, T>
source§impl<'a, R, T> Display for RwLockReadGuard<'a, R, T>
impl<'a, R, T> Display for RwLockReadGuard<'a, R, T>
source§impl<'a, R, T> Drop for RwLockReadGuard<'a, R, T>
impl<'a, R, T> Drop for RwLockReadGuard<'a, R, T>
impl<R, T> Sync for RwLockReadGuard<'_, R, T>
Auto Trait Implementations§
impl<'a, R, T> Freeze for RwLockReadGuard<'a, R, T>where
T: ?Sized,
impl<'a, R, T> !RefUnwindSafe for RwLockReadGuard<'a, R, T>
impl<'a, R, T> Send for RwLockReadGuard<'a, R, T>
impl<'a, R, T> Unpin for RwLockReadGuard<'a, R, T>
impl<'a, R, T> !UnwindSafe for RwLockReadGuard<'a, R, T>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more