Struct parking_lot::MutexGuard

pub struct MutexGuard<'a, T: ?Sized + 'a> { /* fields omitted */ }

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, T: ?Sized + 'a> MutexGuard<'a, T>

pub fn unlock_fair(self)

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.

Trait Implementations

impl<'a, T: ?Sized + 'a> Deref for MutexGuard<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: ?Sized + 'a> DerefMut for MutexGuard<'a, T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<'a, T: ?Sized + 'a> Drop for MutexGuard<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T: ?Sized> StableAddress for MutexGuard<'a, T>