MappedRwLockReadGuard in std::sync - Rust (original) (raw)

Struct MappedRwLockReadGuard

Source

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

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

Expand description

RAII structure used to release the shared read 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 RwLockReadGuard.

Source§

Source

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

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

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

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

§Panics

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

Source

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

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

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

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

§Panics

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