pub struct ReentrantMutexGuard<'a, R, G, T> where
R: RawMutex,
G: GetThreadId,
T: ?Sized, { /* private fields */ }
Expand description
An RAII implementation of a “scoped lock” of a reentrant mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.
The data protected by the mutex can be accessed through this guard via its
Deref
implementation.
Implementations
impl<'a, R, G, T> ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
pub fn remutex(
s: &ReentrantMutexGuard<'a, R, G, T>
) -> &'a ReentrantMutex<R, G, T>
pub fn remutex(
s: &ReentrantMutexGuard<'a, R, G, T>
) -> &'a ReentrantMutex<R, G, T>
Returns a reference to the original ReentrantMutex
object.
pub fn map<U, F>(
s: ReentrantMutexGuard<'a, R, G, T>,
f: F
) -> MappedReentrantMutexGuard<'a, R, G, U> where
F: FnOnce(&T) -> &U,
U: ?Sized,
pub fn map<U, F>(
s: ReentrantMutexGuard<'a, R, G, T>,
f: F
) -> MappedReentrantMutexGuard<'a, R, G, U> where
F: FnOnce(&T) -> &U,
U: ?Sized,
Makes a new MappedReentrantMutexGuard
for a component of the locked data.
This operation cannot fail as the ReentrantMutexGuard
passed
in already locked the mutex.
This is an associated function that needs to be
used as ReentrantMutexGuard::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: ReentrantMutexGuard<'a, R, G, T>,
f: F
) -> Result<MappedReentrantMutexGuard<'a, R, G, U>, ReentrantMutexGuard<'a, R, G, T>> where
F: FnOnce(&mut T) -> Option<&mut U>,
U: ?Sized,
pub fn try_map<U, F>(
s: ReentrantMutexGuard<'a, R, G, T>,
f: F
) -> Result<MappedReentrantMutexGuard<'a, R, G, U>, ReentrantMutexGuard<'a, R, G, T>> where
F: FnOnce(&mut T) -> Option<&mut 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 ReentrantMutexGuard
passed
in already locked the mutex.
This is an associated function that needs to be
used as ReentrantMutexGuard::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 ReentrantMutexGuard<'a, R, G, T>, f: F) -> U where
F: FnOnce() -> U,
pub fn unlocked<F, U>(s: &mut ReentrantMutexGuard<'a, R, G, T>, f: F) -> U where
F: FnOnce() -> U,
Temporarily unlocks the mutex to execute the given function.
This is safe because &mut
guarantees that there exist no other
references to the data protected by the mutex.
impl<'a, R, G, T> ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutexFair,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutexFair,
G: 'a + GetThreadId,
T: 'a + ?Sized,
pub fn unlock_fair(s: ReentrantMutexGuard<'a, R, G, T>)
pub fn unlock_fair(s: ReentrantMutexGuard<'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.
pub fn unlocked_fair<F, U>(s: &mut ReentrantMutexGuard<'a, R, G, T>, f: F) -> U where
F: FnOnce() -> U,
pub fn unlocked_fair<F, U>(s: &mut ReentrantMutexGuard<'a, R, G, T>, f: F) -> U where
F: FnOnce() -> U,
Temporarily unlocks the mutex to execute the given function.
The mutex is unlocked a fair unlock protocol.
This is safe because &mut
guarantees that there exist no other
references to the data protected by the mutex.
pub fn bump(s: &mut ReentrantMutexGuard<'a, R, G, T>)
pub fn bump(s: &mut ReentrantMutexGuard<'a, R, G, T>)
Temporarily yields the mutex to a waiting thread if there is one.
This method is functionally equivalent to calling unlock_fair
followed
by lock
, however it can be much more efficient in the case where there
are no waiting threads.
Trait Implementations
impl<'a, R, G, T> Debug for ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + Debug + ?Sized,
impl<'a, R, G, T> Debug for ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + Debug + ?Sized,
impl<'a, R, G, T> Deref for ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> Deref for ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> Display for ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + Display + ?Sized,
impl<'a, R, G, T> Display for ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + Display + ?Sized,
impl<'a, R, G, T> Drop for ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> Drop for ReentrantMutexGuard<'a, R, G, T> where
R: 'a + RawMutex,
G: 'a + GetThreadId,
T: 'a + ?Sized,
impl<'a, R, G, T> Sync for ReentrantMutexGuard<'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 ReentrantMutexGuard<'a, R, G, T>
impl<'a, R, G, T> !Send for ReentrantMutexGuard<'a, R, G, T>
impl<'a, R, G, T: ?Sized> Unpin for ReentrantMutexGuard<'a, R, G, T>
impl<'a, R, G, T> !UnwindSafe for ReentrantMutexGuard<'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> 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<T> Pointable for T
impl<T> Pointable for T
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