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: 'a + RawRwLock,
T: 'a + ?Sized,
impl<'a, R, T> RwLockWriteGuard<'a, R, T> where
R: 'a + RawRwLock,
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: for<'_> 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: for<'_> 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: for<'_> 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: for<'_> 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::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) -> U where
F: FnOnce() -> U,
pub fn unlocked<F, U>(s: &mut RwLockWriteGuard<'a, R, T>, f: F) -> U where
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: 'a + RawRwLockDowngrade,
T: 'a + ?Sized,
impl<'a, R, T> RwLockWriteGuard<'a, R, T> where
R: 'a + RawRwLockDowngrade,
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: 'a + RawRwLockUpgradeDowngrade,
T: 'a + ?Sized,
impl<'a, R, T> RwLockWriteGuard<'a, R, T> where
R: 'a + RawRwLockUpgradeDowngrade,
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: 'a + RawRwLockFair,
T: 'a + ?Sized,
impl<'a, R, T> RwLockWriteGuard<'a, R, T> where
R: 'a + RawRwLockFair,
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) -> U where
F: FnOnce() -> U,
pub fn unlocked_fair<F, U>(s: &mut RwLockWriteGuard<'a, R, T>, f: F) -> U where
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: 'a + RawRwLock,
T: 'a + Debug + ?Sized,
impl<'a, R, T> Debug for RwLockWriteGuard<'a, R, T> where
R: 'a + RawRwLock,
T: 'a + Debug + ?Sized,
impl<'a, R, T> Deref for RwLockWriteGuard<'a, R, T> where
R: 'a + RawRwLock,
T: 'a + ?Sized,
impl<'a, R, T> Deref for RwLockWriteGuard<'a, R, T> where
R: 'a + RawRwLock,
T: 'a + ?Sized,
impl<'a, R, T> DerefMut for RwLockWriteGuard<'a, R, T> where
R: 'a + RawRwLock,
T: 'a + ?Sized,
impl<'a, R, T> DerefMut for RwLockWriteGuard<'a, R, T> where
R: 'a + RawRwLock,
T: 'a + ?Sized,
impl<'a, R, T> Display for RwLockWriteGuard<'a, R, T> where
R: 'a + RawRwLock,
T: 'a + Display + ?Sized,
impl<'a, R, T> Display for RwLockWriteGuard<'a, R, T> where
R: 'a + RawRwLock,
T: 'a + Display + ?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> Sync for RwLockWriteGuard<'a, R, T> where
R: Sync,
T: Send + Sync,
<R as RawRwLock>::GuardMarker: Sync,
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
impl<A> DynCastExt for A
impl<A> DynCastExt for A
fn dyn_cast<T>(
self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
A: DynCastExtHelper<T>,
T: ?Sized,
fn dyn_cast<T>(
self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
A: DynCastExtHelper<T>,
T: ?Sized,
Use this to cast from one trait object type to another. Read more
fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
T: ?Sized,
fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
T: ?Sized,
Use this to upcast a trait to one of its supertraits. Read more
fn dyn_cast_adv<F, T>(
self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
A: DynCastExtAdvHelper<F, T>,
F: ?Sized,
T: ?Sized,
fn dyn_cast_adv<F, T>(
self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
A: DynCastExtAdvHelper<F, T>,
F: ?Sized,
T: ?Sized,
fn dyn_cast_with_config<C>(
self
) -> Result<<A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Target, <A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Source> where
C: DynCastConfig,
A: DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>,
fn dyn_cast_with_config<C>(
self
) -> Result<<A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Target, <A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Source> where
C: DynCastConfig,
A: DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>,
Use this to cast from one trait object type to another. With this method the type parameter is a config type that uniquely specifies which cast should be preformed. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more