Struct bones_framework::prelude::bones_schema::prelude::bones_utils::prelude::parking_lot::lock_api::RwLockWriteGuard
pub struct RwLockWriteGuard<'a, R, T>where
R: RawRwLock,
T: ?Sized,{ /* private fields */ }
Expand description
RAII structure used to release the exclusive write access of a lock when dropped.
Implementations§
§impl<'a, R, T> RwLockWriteGuard<'a, R, T>where
R: RawRwLock + 'a,
T: 'a + ?Sized,
impl<'a, R, T> RwLockWriteGuard<'a, R, T>where R: RawRwLock + 'a, T: 'a + ?Sized,
pub fn rwlock(s: &RwLockWriteGuard<'a, R, T>) -> &'a RwLock<R, T>
pub fn rwlock(s: &RwLockWriteGuard<'a, R, T>) -> &'a RwLock<R, T>
Returns a reference to the original reader-writer lock object.
pub fn map<U, F>(
s: RwLockWriteGuard<'a, R, T>,
f: F
) -> MappedRwLockWriteGuard<'a, R, U>where
F: FnOnce(&mut T) -> &mut U,
U: ?Sized,
pub fn map<U, F>( s: RwLockWriteGuard<'a, R, T>, f: F ) -> MappedRwLockWriteGuard<'a, R, U>where F: FnOnce(&mut T) -> &mut U, U: ?Sized,
Make a new MappedRwLockWriteGuard
for a component of the locked data.
This operation cannot fail as the RwLockWriteGuard
passed
in already locked the data.
This is an associated function that needs to be
used as RwLockWriteGuard::map(...)
. A method would interfere with methods of
the same name on the contents of the locked data.
pub fn try_map<U, F>(
s: RwLockWriteGuard<'a, R, T>,
f: F
) -> Result<MappedRwLockWriteGuard<'a, R, U>, RwLockWriteGuard<'a, R, T>>where
F: FnOnce(&mut T) -> Option<&mut U>,
U: ?Sized,
pub fn try_map<U, F>( s: RwLockWriteGuard<'a, R, T>, f: F ) -> Result<MappedRwLockWriteGuard<'a, R, U>, RwLockWriteGuard<'a, R, T>>where F: FnOnce(&mut T) -> Option<&mut U>, U: ?Sized,
Attempts to make a new MappedRwLockWriteGuard
for a component of the
locked data. The original guard is return if the closure returns None
.
This operation cannot fail as the RwLockWriteGuard
passed
in already locked the data.
This is an associated function that needs to be
used as RwLockWriteGuard::try_map(...)
. A method would interfere with methods of
the same name on the contents of the locked data.
pub fn unlocked<F, U>(s: &mut RwLockWriteGuard<'a, R, T>, f: F) -> Uwhere
F: FnOnce() -> U,
pub fn unlocked<F, U>(s: &mut RwLockWriteGuard<'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
.
§impl<'a, R, T> RwLockWriteGuard<'a, R, T>where
R: RawRwLockDowngrade + 'a,
T: 'a + ?Sized,
impl<'a, R, T> RwLockWriteGuard<'a, R, T>where R: RawRwLockDowngrade + 'a, T: 'a + ?Sized,
pub fn downgrade(s: RwLockWriteGuard<'a, R, T>) -> RwLockReadGuard<'a, R, T>
pub fn downgrade(s: RwLockWriteGuard<'a, R, T>) -> RwLockReadGuard<'a, 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.
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.
§impl<'a, R, T> RwLockWriteGuard<'a, R, T>where
R: RawRwLockUpgradeDowngrade + 'a,
T: 'a + ?Sized,
impl<'a, R, T> RwLockWriteGuard<'a, R, T>where R: RawRwLockUpgradeDowngrade + 'a, T: 'a + ?Sized,
pub fn downgrade_to_upgradable(
s: RwLockWriteGuard<'a, R, T>
) -> RwLockUpgradableReadGuard<'a, R, T>
pub fn downgrade_to_upgradable( s: RwLockWriteGuard<'a, R, T> ) -> RwLockUpgradableReadGuard<'a, 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.
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.
§impl<'a, R, T> RwLockWriteGuard<'a, R, T>where
R: RawRwLockFair + 'a,
T: 'a + ?Sized,
impl<'a, R, T> RwLockWriteGuard<'a, R, T>where R: RawRwLockFair + 'a, T: 'a + ?Sized,
pub fn unlock_fair(s: RwLockWriteGuard<'a, R, T>)
pub fn unlock_fair(s: RwLockWriteGuard<'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 RwLockWriteGuard
normally.
pub fn unlocked_fair<F, U>(s: &mut RwLockWriteGuard<'a, R, T>, f: F) -> Uwhere
F: FnOnce() -> U,
pub fn unlocked_fair<F, U>(s: &mut RwLockWriteGuard<'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
.
pub fn bump(s: &mut RwLockWriteGuard<'a, R, T>)
pub fn bump(s: &mut RwLockWriteGuard<'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 write
, however it can be much more efficient in the case where there
are no waiting threads.
Trait Implementations§
§impl<'a, R, T> Debug for RwLockWriteGuard<'a, R, T>where
R: RawRwLock + 'a,
T: Debug + 'a + ?Sized,
impl<'a, R, T> Debug for RwLockWriteGuard<'a, R, T>where R: RawRwLock + 'a, T: Debug + 'a + ?Sized,
§impl<'a, R, T> Deref for RwLockWriteGuard<'a, R, T>where
R: RawRwLock + 'a,
T: 'a + ?Sized,
impl<'a, R, T> Deref for RwLockWriteGuard<'a, R, T>where R: RawRwLock + 'a, T: 'a + ?Sized,
§impl<'a, R, T> DerefMut for RwLockWriteGuard<'a, R, T>where
R: RawRwLock + 'a,
T: 'a + ?Sized,
impl<'a, R, T> DerefMut for RwLockWriteGuard<'a, R, T>where R: RawRwLock + 'a, T: 'a + ?Sized,
§impl<'a, R, T> Display for RwLockWriteGuard<'a, R, T>where
R: RawRwLock + 'a,
T: Display + 'a + ?Sized,
impl<'a, R, T> Display for RwLockWriteGuard<'a, R, T>where R: RawRwLock + 'a, T: Display + 'a + ?Sized,
§impl<'a, R, T> Drop for RwLockWriteGuard<'a, R, T>where
R: RawRwLock + 'a,
T: 'a + ?Sized,
impl<'a, R, T> Drop for RwLockWriteGuard<'a, R, T>where R: RawRwLock + 'a, T: 'a + ?Sized,
impl<R, T> Sync for RwLockWriteGuard<'_, R, T>where R: RawRwLock + Sync, T: Sync + ?Sized,
Auto Trait Implementations§
impl<'a, R, T> !RefUnwindSafe for RwLockWriteGuard<'a, R, T>
impl<'a, R, T: ?Sized> Send for RwLockWriteGuard<'a, R, T>where R: Sync, T: Send + Sync, <R as RawRwLock>::GuardMarker: Send,
impl<'a, R, T: ?Sized> Unpin for RwLockWriteGuard<'a, R, T>where <R as RawRwLock>::GuardMarker: Unpin,
impl<'a, R, T> !UnwindSafe for RwLockWriteGuard<'a, R, T>
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere T: 'a,
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
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_mut()
into the pipe
function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds.