Struct ReadGuard 

pub struct ReadGuard<'a, T, Codec = Default>(/* private fields */);

Available on crate feature robj only.

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

As long as this is held, no write access to the lock can occur. It is therefore recommend to either hold the guard for only short periods of time or call invalidated to be notified when write access is requested.

Implementations

impl<T, Codec> ReadGuard<'_, T, Codec>

where Codec: Codec,

pub async fn invalidated(&self)

Waits until the shared value is invalidated because a write request is made.

In this case the holder should drop this guard and reissue the read request to obtain the new value. As long as the guard is held the shared value will not be changed.

This also returns when the owner is dropped or a connection error occurs.

pub fn is_invalidated(&self) -> bool

Returns true, if the shared value has been invalidated.

Trait Implementations

impl<T, Codec> Debug for ReadGuard<'_, T, Codec>

where T: Debug,

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

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

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.