Struct holochain::prelude::kitsune_p2p::dependencies::kitsune_p2p_types::dependencies::lair_keystore_api::dependencies::parking_lot::lock_api::MutexGuard
Expand description
An RAII implementation of a “scoped lock” of a 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
and DerefMut
implementations.
Implementations
impl<'a, R, T> MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + ?Sized,
impl<'a, R, T> MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + ?Sized,
pub fn mutex(s: &MutexGuard<'a, R, T>) -> &'a Mutex<R, T>
pub fn mutex(s: &MutexGuard<'a, R, T>) -> &'a Mutex<R, T>
Returns a reference to the original Mutex
object.
pub fn map<U, F>(s: MutexGuard<'a, R, T>, f: F) -> MappedMutexGuard<'a, R, U>where
F: FnOnce(&mut T) -> &mut U,
U: ?Sized,
pub fn map<U, F>(s: MutexGuard<'a, R, T>, f: F) -> MappedMutexGuard<'a, R, U>where
F: FnOnce(&mut T) -> &mut U,
U: ?Sized,
Makes a new MappedMutexGuard
for a component of the locked data.
This operation cannot fail as the MutexGuard
passed
in already locked the mutex.
This is an associated function that needs to be
used as MutexGuard::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: MutexGuard<'a, R, T>,
f: F
) -> Result<MappedMutexGuard<'a, R, U>, MutexGuard<'a, R, T>>where
F: FnOnce(&mut T) -> Option<&mut U>,
U: ?Sized,
pub fn try_map<U, F>(
s: MutexGuard<'a, R, T>,
f: F
) -> Result<MappedMutexGuard<'a, R, U>, MutexGuard<'a, R, T>>where
F: FnOnce(&mut T) -> Option<&mut U>,
U: ?Sized,
Attempts to make a new MappedMutexGuard
for a component of the
locked data. The original guard is returned if the closure returns None
.
This operation cannot fail as the MutexGuard
passed
in already locked the mutex.
This is an associated function that needs to be
used as MutexGuard::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 MutexGuard<'a, R, T>, f: F) -> Uwhere
F: FnOnce() -> U,
pub fn unlocked<F, U>(s: &mut MutexGuard<'a, R, T>, f: F) -> Uwhere
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.
pub fn leak(s: MutexGuard<'a, R, T>) -> &'a mut T
pub fn leak(s: MutexGuard<'a, R, T>) -> &'a mut T
Leaks the mutex guard and returns a mutable reference to the data protected by the mutex.
This will leave the Mutex
in a locked state.
impl<'a, R, T> MutexGuard<'a, R, T>where
R: 'a + RawMutexFair,
T: 'a + ?Sized,
impl<'a, R, T> MutexGuard<'a, R, T>where
R: 'a + RawMutexFair,
T: 'a + ?Sized,
pub fn unlock_fair(s: MutexGuard<'a, R, T>)
pub fn unlock_fair(s: MutexGuard<'a, R, 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 MutexGuard
normally.
pub fn unlocked_fair<F, U>(s: &mut MutexGuard<'a, R, T>, f: F) -> Uwhere
F: FnOnce() -> U,
pub fn unlocked_fair<F, U>(s: &mut MutexGuard<'a, R, T>, f: F) -> Uwhere
F: FnOnce() -> U,
Temporarily unlocks the mutex to execute the given function.
The mutex is unlocked using 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 MutexGuard<'a, R, T>)
pub fn bump(s: &mut MutexGuard<'a, R, 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, T> Debug for MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + Debug + ?Sized,
impl<'a, R, T> Debug for MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + Debug + ?Sized,
impl<'a, R, T> Deref for MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + ?Sized,
impl<'a, R, T> Deref for MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + ?Sized,
impl<'a, R, T> DerefMut for MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + ?Sized,
impl<'a, R, T> DerefMut for MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + ?Sized,
impl<'a, R, T> Display for MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + Display + ?Sized,
impl<'a, R, T> Display for MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + Display + ?Sized,
impl<'a, R, T> Drop for MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + ?Sized,
impl<'a, R, T> Drop for MutexGuard<'a, R, T>where
R: 'a + RawMutex,
T: 'a + ?Sized,
impl<'a, R, T> Sync for MutexGuard<'a, R, T>where
R: 'a + RawMutex + Sync,
T: 'a + Sync + ?Sized,
Auto Trait Implementations
impl<'a, R, T> !RefUnwindSafe for MutexGuard<'a, R, T>
impl<'a, R, T: ?Sized> Send for MutexGuard<'a, R, T>where
R: Sync,
T: Send,
<R as RawMutex>::GuardMarker: Send,
impl<'a, R, T: ?Sized> Unpin for MutexGuard<'a, R, T>where
<R as RawMutex>::GuardMarker: Unpin,
impl<'a, R, T> !UnwindSafe for MutexGuard<'a, R, T>
Blanket Implementations
impl<T> Any for Twhere
T: Any + ?Sized,
impl<T> Any for Twhere
T: Any + ?Sized,
fn type_id_compat(&self) -> TypeId
fn type_id_compat(&self) -> TypeId
impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
type ArchivedMetadata = ()
type ArchivedMetadata = ()
fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
impl<T> FutureExt for T
impl<T> FutureExt for T
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
sourcefn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
sourcefn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read morefn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.