Struct mycelium_util::sync::blocking::RwLockReadGuard

pub struct RwLockReadGuard<'lock, T, Lock = RwSpinlock>
where
    Lock: RawRwLock,
    T: ?Sized,
{ /* private fields */ }

An RAII implementation of a “scoped read lock” of a RwLock. When this structure is dropped (falls out of scope), the lock will be unlocked.

The data protected by the RwLock can be immutably accessed through this guard via its Deref implementation.

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

Trait Implementations

impl<T, R, Lock> AsRef<R> for RwLockReadGuard<'_, T, Lock>

where T: AsRef<R> + ?Sized, Lock: RawRwLock, R: ?Sized,

fn as_ref(&self) -> &R

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, Lock> Debug for RwLockReadGuard<'_, T, Lock>

where T: Debug + ?Sized, Lock: RawRwLock,

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

Formats the value using the given formatter.

impl<T, Lock> Deref for RwLockReadGuard<'_, T, Lock>

where Lock: RawRwLock, T: ?Sized,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<RwLockReadGuard<'_, T, Lock> as Deref>::Target

Dereferences the value.

impl<T, Lock> Display for RwLockReadGuard<'_, T, Lock>

where T: Display + ?Sized, Lock: RawRwLock,

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

Formats the value using the given formatter.

impl<T, Lock> Drop for RwLockReadGuard<'_, T, Lock>

where Lock: RawRwLock, T: ?Sized,

fn drop(&mut self)

Executes the destructor for this type.

impl<T, Lock> Send for RwLockReadGuard<'_, T, Lock>

where T: Sync + ?Sized, Lock: RawRwLock + Sync, <Lock as RawRwLock>::GuardMarker: Send,

A RwLockReadGuard is Send if both T and the Lock type parameter are Sync, because sending a RwLockReadGuard is equivalent to sending a &(T, Lock).

Additionally, the Lock type’s RawRwLock::GuardMarker must indicate that the guard is Send.

impl<T, Lock> Sync for RwLockReadGuard<'_, T, Lock>

where T: Sync + ?Sized, Lock: RawRwLock + Sync,

A RwLockReadGuard is Sync if both T and the Lock type parameter are Sync.