Struct MutexGuard

Source

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

🔬This is a nightly-only experimental API. (nonpoison_mutex #134645)

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.

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

Implementations§

Source §

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

Source

pub fn map<U, F>(orig: Self, f: F) -> MappedMutexGuard<'a, U>
where F: FnOnce(&mut T) -> &mut U, U: ?Sized,

🔬This is a nightly-only experimental API. (mapped_lock_guards #117108)

Makes a MappedMutexGuard for a component of the borrowed data, e.g. an enum variant.

The Mutex is already locked, so this cannot fail.

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 MutexGuard used through Deref.

Source

pub fn filter_map<U, F>( orig: Self, f: F, ) -> Result<MappedMutexGuard<'a, U>, Self>
where F: FnOnce(&mut T) -> Option<&mut U>, U: ?Sized,

🔬This is a nightly-only experimental API. (mapped_lock_guards #117108)

Makes a MappedMutexGuard for a component of the borrowed data. The original guard is returned as an Err(...) if the closure returns None.

The Mutex is already locked, so this cannot fail.

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

Trait Implementations§

Source §

impl<T: ?Sized + Debug> Debug for MutexGuard<'_, T>

Source §

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

Formats the value using the given formatter. Read more

Source §

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

Source §

type Target = T

The resulting type after dereferencing.

Source §

fn deref(&self) -> &T

Dereferences the value.

Source §

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

Source §

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

Mutably dereferences the value.

Source §

impl<T: ?Sized + Display> Display for MutexGuard<'_, T>

Source §

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

Formats the value using the given formatter. Read more

Source §

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

Source §

fn drop(&mut self)

Executes the destructor for this type. Read more

Source §

impl<T: ?Sized> !Send for MutexGuard<'_, T>

A MutexGuard is not Send to maximize platform portablity.

On platforms that use POSIX threads (commonly referred to as pthreads) there is a requirement to release mutex locks on the same thread they were acquired. For this reason, MutexGuard must not implement Send to prevent it being dropped from another thread.

Source §