Struct MutexGuard 

pub struct MutexGuard<'a, P: Priority, T: ?Sized, Q: MutexQueue<P>> { /* private fields */ }

A guard holding access for a Mutex. When dropped, the lock is released.

If the evict flag is enabled, higher priority requesters will mark held locks for eviction, which can be subscribed to via Self::evicted (associated function).

Implementations

impl<'a, P: Priority, T: ?Sized, Q: MutexQueue<P>> MutexGuard<'a, P, T, Q>

pub fn evicted(this: &mut Self) -> impl Future<Output = ()>

Returns a future which resolves when/if another, higher priority holder attempts to acquire the lock.

Note: this is an associated method to avoid colision with methods of T. Invoke via MutexGuard::evicted(&mut self).

Cancel Safety: This function is cancel safe.

Trait Implementations

impl<'a, P: Priority, T, Q: MutexQueue<P>> Debug for MutexGuard<'a, P, T, Q>

where T: Debug + ?Sized,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, P: Priority, T: ?Sized, Q: MutexQueue<P>> Deref for MutexGuard<'a, P, T, Q>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, P: Priority, T: ?Sized, Q: MutexQueue<P>> DerefMut for MutexGuard<'a, P, T, Q>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, P: Priority, T, Q: MutexQueue<P>> Display for MutexGuard<'a, P, T, Q>

where T: Display + ?Sized,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, P: Priority, T: ?Sized, Q: MutexQueue<P>> Drop for MutexGuard<'a, P, T, Q>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, P: Priority, T: ?Sized + Send, Q: MutexQueue<P>> Send for MutexGuard<'a, P, T, Q>

where Mutex<P, T, Q>: Sync, Q::Handle: Send,

impl<'a, P: Priority, T: ?Sized + Sync, Q: MutexQueue<P>> Sync for MutexGuard<'a, P, T, Q>

where Mutex<P, T, Q>: Sync,