Struct otter::prelude::parking_lot::lock_api::MappedReentrantMutexGuard
[−]pub struct MappedReentrantMutexGuard<'a, R, G, T> where
R: RawMutex,
G: GetThreadId,
T: ?Sized, { /* private fields */ }
Expand description
An RAII mutex guard returned by ReentrantMutexGuard::map
, which can point to a
subfield of the protected data.
The main difference between MappedReentrantMutexGuard
and ReentrantMutexGuard
is that the
former doesn’t support temporarily unlocking and re-locking, since that
could introduce soundness issues if the locked object is modified by another
thread.
Implementations
impl<'a, R, G, T> MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
pub fn map<U, F>(
s: MappedReentrantMutexGuard<'a, R, G, T>,
f: F
) -> MappedReentrantMutexGuard<'a, R, G, U> where
F: for<'_> FnOnce(&T) -> &U,
U: ?Sized,
pub fn map<U, F>(
s: MappedReentrantMutexGuard<'a, R, G, T>,
f: F
) -> MappedReentrantMutexGuard<'a, R, G, U> where
F: for<'_> FnOnce(&T) -> &U,
U: ?Sized,
Makes a new MappedReentrantMutexGuard
for a component of the locked data.
This operation cannot fail as the MappedReentrantMutexGuard
passed
in already locked the mutex.
This is an associated function that needs to be
used as MappedReentrantMutexGuard::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: MappedReentrantMutexGuard<'a, R, G, T>,
f: F
) -> Result<MappedReentrantMutexGuard<'a, R, G, U>, MappedReentrantMutexGuard<'a, R, G, T>> where
F: for<'_> FnOnce(&T) -> Option<&U>,
U: ?Sized,
pub fn try_map<U, F>(
s: MappedReentrantMutexGuard<'a, R, G, T>,
f: F
) -> Result<MappedReentrantMutexGuard<'a, R, G, U>, MappedReentrantMutexGuard<'a, R, G, T>> where
F: for<'_> FnOnce(&T) -> Option<&U>,
U: ?Sized,
Attempts to make a new MappedReentrantMutexGuard
for a component of the
locked data. The original guard is return if the closure returns None
.
This operation cannot fail as the MappedReentrantMutexGuard
passed
in already locked the mutex.
This is an associated function that needs to be
used as MappedReentrantMutexGuard::map(...)
. A method would interfere with methods of
the same name on the contents of the locked data.
impl<'a, R, G, T> MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutexFair,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutexFair,
G: 'a + GetThreadId,
T: 'a + ?Sized,
pub fn unlock_fair(s: MappedReentrantMutexGuard<'a, R, G, T>)
pub fn unlock_fair(s: MappedReentrantMutexGuard<'a, R, G, T>)
Unlocks the mutex using a fair unlock protocol.
By default, mutexes are unfair and allow the current thread to re-lock the mutex before another has the chance to acquire the lock, even if that thread has been blocked on the mutex for a long time. This is the default because it allows much higher throughput as it avoids forcing a context switch on every mutex unlock. This can result in one thread acquiring a mutex 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 ReentrantMutexGuard
normally.
Trait Implementations
impl<'a, R, G, T> Debug for MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + Debug + ?Sized,
impl<'a, R, G, T> Debug for MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + Debug + ?Sized,
impl<'a, R, G, T> Deref for MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> Deref for MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> Display for MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + Display + ?Sized,
impl<'a, R, G, T> Display for MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + Display + ?Sized,
impl<'a, R, G, T> Drop for MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> Drop for MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> Sync for MappedReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex + Sync,
G: 'a + GetThreadId + Sync,
T: 'a + Sync + ?Sized,
Auto Trait Implementations
impl<'a, R, G, T> !RefUnwindSafe for MappedReentrantMutexGuard<'a, R, G, T>
impl<'a, R, G, T> !Send for MappedReentrantMutexGuard<'a, R, G, T>
impl<'a, R, G, T: ?Sized> Unpin for MappedReentrantMutexGuard<'a, R, G, T>
impl<'a, R, G, T> !UnwindSafe for MappedReentrantMutexGuard<'a, R, G, 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
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn 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<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<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<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
sourcefn 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
sourcefn 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
sourcefn 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
sourceimpl<A> DynCastExt for A
impl<A> DynCastExt for A
sourcefn 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
sourcefn 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
sourcefn 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,
sourcefn 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