Struct more_sync::VersionedGuard

pub struct VersionedGuard<'a, T> { /* fields omitted */ }

Mutex guard returned by VersionedParker::lock.

Implementations

impl<'a, T> VersionedGuard<'a, T>

pub fn version(&self) -> usize

Returns the current version.

The version will not change unless wait() or wait_timeout() is called.

pub fn notified(&self) -> bool

Returns if we were notified during last period.

If we never waited, notified() returns false.

pub fn notified_count(&self) -> usize

Returns the number of times we were notified during last wait.

If we never waited, notification_count() returns 0.

pub fn wait(&mut self)

Blocks the current thread until notified.

wait() updates the version stored in this guard.

pub fn wait_timeout(&mut self, timeout: Duration) -> WaitTimeoutResult

Blocks the current thread until notified, for up to timeout.

wait_timeout() updates the version stored in this guard.

Trait Implementations

impl<'a, T: Debug> Debug for VersionedGuard<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Deref for VersionedGuard<'a, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, T> DerefMut for VersionedGuard<'a, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.