Struct maitake::sync::spin::RwLockReadGuard

pub struct RwLockReadGuard<'lock, T>
where
    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> AsRef<R> for RwLockReadGuard<'_, T>

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

fn as_ref(&self) -> &R

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

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

where T: Debug + ?Sized,

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

Formats the value using the given formatter.

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

where T: ?Sized,

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

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

where T: Display + ?Sized,

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

Formats the value using the given formatter.

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

where T: ?Sized,

fn drop(&mut self)

Executes the destructor for this type.

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

where T: Sync + ?Sized,

A RwLockReadGuard only allows immutable (&T) access to a T. Therefore, it is Send and Sync as long as T is Sync, because it can be used to share references to a T across multiple threads (requiring T: Sync), but it cannot be used to move ownership of a T across thread boundaries, as the T cannot be taken out of the lock through a RwLockReadGuard.

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

where T: Sync + ?Sized,