Struct ReadGuard

pub struct ReadGuard<'lock, T, U = T> { /* private fields */ }

A RAII guard that guarantees shared read access to a TryRwLock.

Implementations

impl<'lock, T, U> ReadGuard<'lock, T, U>

pub fn rwlock(guard: &Self) -> &'lock TryRwLock<T>

Get a shared reference to the lock that this read guard has locked.

pub fn try_upgrade(guard: Self) -> Result<WriteGuard<'lock, T>, Self>

Attempt to upgrade the ReadGuard to a WriteGuard.

Note that for soundness reasons, this will undo any mapping that has previously been applied.

Errors

Fails if there is more than one reader currently using the lock.

pub fn map<V>(guard: Self, f: impl FnOnce(&U) -> &V) -> ReadGuard<'lock, T, V>

Map to another value and keep locked.

pub fn unmap(guard: Self) -> ReadGuard<'lock, T>

Undo any previous mapping applied, returning the guard back to its original state.

Trait Implementations

impl<T, U: Debug> Debug for ReadGuard<'_, T, U>

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

Formats the value using the given formatter.

impl<T, U> Deref for ReadGuard<'_, T, U>

type Target = U

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, U: Display> Display for ReadGuard<'_, T, U>

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

Formats the value using the given formatter.

impl<T, U> Drop for ReadGuard<'_, T, U>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Sync, U: Sync> Send for ReadGuard<'_, T, U>

impl<T: Sync, U: Sync> Sync for ReadGuard<'_, T, U>