Struct RwLockReadGuard

pub struct RwLockReadGuard<'a, T: ?Sized + 'a> {
    data: NonNull<T>,
    inner_lock: &'a RwLock,
}

RAII structure used to release the shared read access of a lock when dropped.

This structure is created by the read and try_read methods on RwLock.

Fields

data: NonNull<T>

inner_lock: &'a RwLock

Implementations

impl<'rwlock, T: ?Sized> RwLockReadGuard<'rwlock, T>

unsafe fn new( lock: &'rwlock RwLock<T>, ) -> LockResult<RwLockReadGuard<'rwlock, T>>

🔬This is a nightly-only experimental API. (sync_poison_mod #134646)

Creates a new instance of RwLockReadGuard<T> from a RwLock<T>.

Safety

This function is safe if and only if the same thread has successfully and safely called lock.inner.read(), lock.inner.try_read(), or lock.inner.downgrade() before instantiating this object.

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

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

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

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

Panics

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

pub fn try_map<U, F>( orig: Self, f: F, ) -> Result<MappedRwLockReadGuard<'a, U>, Self>

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

🔬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 returns None.

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

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

Panics

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

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

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

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