Struct std::sync::MappedRwLockWriteGuard

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

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

RAII structure used to release the exclusive write access of a lock when dropped, which can point to a subfield of the protected data.

This structure is created by the map and try_map methods on RwLockWriteGuard.

Implementations

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

pub fn map<U, F>(orig: Self, f: F) -> MappedRwLockWriteGuard<'a, U>

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

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

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

The RwLock is already locked for writing, so this cannot fail.

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

Panics

If the closure panics, the guard will be dropped (unlocked) and the RwLock will be poisoned.

pub fn try_map<U, F>( orig: Self, f: F ) -> Result<MappedRwLockWriteGuard<'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 MappedRwLockWriteGuard for a component of the borrowed data. The original guard is returned as an Err(...) if the closure returns None.

The RwLock is already locked for writing, so this cannot fail.

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

Panics

If the closure panics, the guard will be dropped (unlocked) and the RwLock will be poisoned.

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Mutably dereferences the value.

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

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

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