Struct spin_sync::RwLockReadGuard

#[must_use = "if unused the RwLock will immediately unlock"]pub struct RwLockReadGuard<'a, T: ?Sized + 'a> { /* fields omitted */ }

An RAII implementation of a "scoped shared read lock" of a RwLock.

When this instance is dropped (falls out of scope), the lock will be released.

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

This instance is created by read and try_read methods on RwLock.

Trait Implementations

impl<T: 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) -> &Self::Target

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)

Make sure to release the shared read lock. This function will never poison the rwlock.

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