Enum WaitTimeoutResult 

pub enum WaitTimeoutResult<R> {
    Ready(R),
    TimedOut,
}

Result of waiting for a predicate with an overall timeout.

This type is returned by Monitor::wait_timeout_while and Monitor::wait_timeout_until. It is more explicit than Option<R>: a ready predicate produces Self::Ready, while an expired timeout produces Self::TimedOut.

Type Parameters

• R - The value produced after the protected state satisfies the predicate.

Example

use std::time::Duration;

use qubit_lock::{Monitor, WaitTimeoutResult};

let monitor = Monitor::new(true);
let result = monitor.wait_timeout_until(
    Duration::from_secs(1),
    |ready| *ready,
    |ready| {
        *ready = false;
        "ready"
    },
);

assert_eq!(result, WaitTimeoutResult::Ready("ready"));

Variants

Ready(R)

The predicate became ready before the timeout and produced this value.

TimedOut

The timeout elapsed before the predicate became ready.

Implementations

impl<R> WaitTimeoutResult<R>

pub const fn is_ready(&self) -> bool

Returns true when the result contains a ready value.

Returns

true for Self::Ready, otherwise false.

pub const fn is_timed_out(&self) -> bool

Returns true when the timeout elapsed before the predicate was ready.

Returns

true for Self::TimedOut, otherwise false.

pub fn into_option(self) -> Option<R>

Converts this result into an Option.

Returns

Some(value) for Self::Ready, or None for Self::TimedOut.

pub fn map<U, F: FnOnce(R) -> U>(self, f: F) -> WaitTimeoutResult<U>

Maps a ready value while preserving timeout status.

Arguments

• f - Closure applied to the contained value when this result is Self::Ready.

Returns

Self::Ready containing the mapped value, or WaitTimeoutResult::TimedOut when this result timed out.

Trait Implementations

impl<R: Clone> Clone for WaitTimeoutResult<R>

fn clone(&self) -> WaitTimeoutResult<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for WaitTimeoutResult<R>

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

Formats the value using the given formatter.

impl<R: PartialEq> PartialEq for WaitTimeoutResult<R>

fn eq(&self, other: &WaitTimeoutResult<R>) -> 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<R: Copy> Copy for WaitTimeoutResult<R>

impl<R: Eq> Eq for WaitTimeoutResult<R>

impl<R> StructuralPartialEq for WaitTimeoutResult<R>