Struct MutexGuard 

pub struct MutexGuard<'a, R: RawMutex, T: ?Sized> { /* private fields */ }

An RAII guard which unlocks the mutex when dropped.

The data protected by the mutex can be accessed through this guard via its Deref and DerefMut implementations.

This structure is created by the lock and try_lock methods on Mutex.

Implementations

impl<'a, R: RawMutex + 'a, T: ?Sized + 'a> MutexGuard<'a, R, T>

pub fn mutex(s: &Self) -> &'a Mutex<R, T>

Returns a reference to the original Mutex object.

pub fn map<U: ?Sized, F>(s: Self, f: F) -> MappedMutexGuard<'a, R, U>

where F: FnOnce(&mut T) -> &mut U,

Makes a new MappedMutexGuard for a component of the locked data.

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.

Panics

If f panics, the original guard is dropped.

pub fn try_map<U: ?Sized, F>( s: Self, f: F, ) -> Result<MappedMutexGuard<'a, R, U>, Self>

where F: FnOnce(&mut T) -> Option<&mut U>,

Attempts to make a new MappedMutexGuard for a component of the locked data. The original guard is returned if the closure returns None.

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.

Panics

If f panics, the original guard is dropped.

pub fn try_map_or_err<U: ?Sized, F, E>( s: Self, f: F, ) -> Result<MappedMutexGuard<'a, R, U>, (Self, E)>

where F: FnOnce(&mut T) -> Result<&mut U, E>,

Attempts to make a new MappedMutexGuard for a component of the locked data. The original guard is returned alongside arbitrary user data if the closure returns Err.

This is an associated function that needs to be used as MutexGuard::try_map_or_err(...). A method would interfere with methods of the same name on the contents of the locked data.

Panics

If f panics, the original guard is dropped.

pub fn unlocked<F, U>(s: &mut Self, 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.

Aborts

Aborts if re-locking the mutex panics.

pub fn leak(s: Self) -> &'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: RawMutexFair + 'a, T: ?Sized + 'a> MutexGuard<'a, R, T>

pub fn unlock_fair(s: Self)

Unlocks the mutex using a fair unlock protocol.

A fair unlock hands the mutex directly to a waiting thread instead of allowing another thread to steal it. This can prevent starvation, but may reduce throughput by forcing a context switch.

pub fn unlocked_fair<F, U>(s: &mut Self, f: F) -> U

where 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.

Aborts

Aborts if re-locking the mutex panics.

pub fn bump(s: &mut Self)

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Mutably dereferences the value.

impl<'a, R: RawMutex + 'a, T: Display + ?Sized + 'a> Display for MutexGuard<'a, R, T>

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.