Enum Timeout

pub enum Timeout {
    DontBlock,
    BlockUntil(Instant),
    BlockIndefinitely,
}

A timeout (or lack thereof) describing how blocking operations should behave.

Variants

DontBlock

Disallows blocking for a contended resource.

BlockUntil(Instant)

Allows blocking for a contended resource until the given time has passed.

BlockIndefinitely

Allows blocking for a contended resource indefinitely.

Implementations

impl Timeout

pub fn block_for(duration: Duration) -> Self

Creates a new timeout that lasts for the provided duration, starting now.

Example

let first_timeout = Timeout::BlockUntil(Instant::now());
let second_timeout = Timeout::block_for(Duration::from_secs(1));
assert!(first_timeout < second_timeout);

pub fn block_for_millis(millis: u64) -> Self

Creates a new timeout that lasts for the provided number of milliseconds, starting now.

Example

let first_timeout = Timeout::BlockUntil(Instant::now());
let second_timeout = Timeout::block_for_millis(1000);
assert!(first_timeout < second_timeout);

Trait Implementations

impl Clone for Timeout

fn clone(&self) -> Timeout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timeout

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

Formats the value using the given formatter.

impl Hash for Timeout

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Timeout

fn cmp(&self, other: &Timeout) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Timeout

fn eq(&self, other: &Timeout) -> 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 PartialOrd for Timeout

fn partial_cmp(&self, other: &Timeout) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Timeout

impl Eq for Timeout

impl StructuralPartialEq for Timeout