Struct futures_timer::Delay

pub struct Delay { /* fields omitted */ }

A future representing the notification that an elapsed duration has occurred.

This is created through the Delay::new or Delay::new_at methods indicating when the future should fire at. Note that these futures are not intended for high resolution timers, but rather they will likely fire some granularity after the exact instant that they're otherwise indicated to fire at.

Methods

impl Delay

Important traits for Delay

impl Future for Delay type Output = ();

pub fn new(dur: Duration) -> Delay

Creates a new future which will fire at dur time into the future.

The returned object will be bound to the default timer for this thread. The default timer will be spun up in a helper thread on first use.

pub fn when(&self) -> Instant

Return the Instant when this delay will fire.

pub fn reset(&mut self, at: Instant)

Resets this timeout to an new timeout which will fire at the time specified by at.

Trait Implementations

impl Drop for Delay

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for Delay

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

Formats the value using the given formatter.

impl Future for Delay

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.