Struct std::sync::MappedMutexGuard

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

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

An RAII mutex guard returned by MutexGuard::map, which can point to a subfield of the protected data. When this structure is dropped (falls out of scope), the lock will be unlocked.

The main difference between MappedMutexGuard and MutexGuard is that the former cannot be used with Condvar, since that could introduce soundness issues if the locked object is modified by another thread while the Mutex is 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 map and try_map methods on MutexGuard.

Implementations

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

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 MappedMutexGuard::map(...). A method would interfere with methods of the same name on the contents of the MutexGuard used through Deref.

pub fn try_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 MappedMutexGuard::try_map(...). A method would interfere with methods of the same name on the contents of the MutexGuard used through Deref.

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Mutably dereferences the value.

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

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

impl<T: ?Sized + Sync> Sync for MappedMutexGuard<'_, T>