Enum WaitTimeoutStatus 

pub enum WaitTimeoutStatus {
    Woken,
    TimedOut,
}

Result of a timed wait operation.

This status is returned by ParkingLotMonitorGuard::wait_timeout and ParkingLotMonitor::wait_for. It describes why a timed wait returned, but callers must still re-check the protected state because condition variables may wake spuriously.

Example

use std::time::Duration;

use qubit_lock::{ParkingLotMonitor, WaitTimeoutStatus};

let monitor = ParkingLotMonitor::new(false);
let guard = monitor.lock();
let (_guard, status) = guard.wait_timeout(Duration::from_millis(1));
assert_eq!(status, WaitTimeoutStatus::TimedOut);

Variants

Woken

The wait returned before the timeout elapsed.

This usually means another thread called ParkingLotMonitor::notify_one or ParkingLotMonitor::notify_all, but it may also be a spurious wakeup. Always re-check the guarded state before acting on this status.

TimedOut

The wait reached the timeout boundary.

Even after this status, callers should inspect the protected state because another thread may have changed it while the waiting thread was reacquiring the mutex.

Implementations

impl WaitTimeoutStatus

pub const fn is_woken(&self) -> bool

Returns true when the wait returned before the timeout elapsed.

Returns

true for Self::Woken, otherwise false.

pub const fn is_timed_out(&self) -> bool

Returns true when the wait reached the timeout boundary.

Returns

true for Self::TimedOut, otherwise false.

Trait Implementations

impl Clone for WaitTimeoutStatus

fn clone(&self) -> WaitTimeoutStatus

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WaitTimeoutStatus

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

Formats the value using the given formatter.

impl PartialEq for WaitTimeoutStatus

fn eq(&self, other: &WaitTimeoutStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for WaitTimeoutStatus

impl Eq for WaitTimeoutStatus

impl StructuralPartialEq for WaitTimeoutStatus