Struct Delay

pub struct Delay<T> {
    pub value: T,
    /* private fields */
}

Wraps a value that should be delayed.

Implements Delayed and Eq. Two Delay objects are equal iff their wrapped values are equal and they are delayed until the same Instant.

Examples

Basic usage:

use delay_queue::{Delay, Delayed};
use std::time::{Duration, Instant};

let delayed_one_hour = Delay::for_duration(123, Duration::from_secs(3600));
let delayed_now = Delay::until_instant("abc", Instant::now());

assert!(delayed_one_hour.delayed_until() > delayed_now.delayed_until());
assert_eq!(delayed_one_hour.value, 123);

Fields

value: T

The value that is delayed.

Implementations

impl<T> Delay<T>

pub fn until_instant(value: T, until: Instant) -> Delay<T>

Creates a new Delay<T> holding value and that is delayed until the given Instant.

Examples

Basic usage:

use delay_queue::Delay;
use std::time::Instant;

let delayed_now = Delay::until_instant("abc", Instant::now());

pub fn for_duration(value: T, duration: Duration) -> Delay<T>

Creates a new Delay<T> holding value and that is delayed until the given Duration has elapsed.

Examples

Basic usage:

use delay_queue::Delay;
use std::time::Duration;

let delayed_one_hour = Delay::for_duration("abc", Duration::from_secs(3600));

Trait Implementations

impl<T: Debug> Debug for Delay<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Delay<T>

fn default() -> Delay<T>

Creates an expired Delay<T> with a default value.

impl<T> Delayed for Delay<T>

fn delayed_until(&self) -> Instant

Returns the Instant until which this value is delayed.

impl<T: PartialEq> PartialEq for Delay<T>

fn eq(&self, other: &Delay<T>) -> 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<T: Eq> Eq for Delay<T>

impl<T> StructuralPartialEq for Delay<T>