Struct async_timer::delay::Delay

#[must_use = "Delay does nothing unless polled"]
pub struct Delay<T = PlatformTimer> { /* fields omitted */ }

Future that resolves sometime in future

Implementation notes

When Future is created, timer is not yet started. The actual timer will start only after future will be initally polled.

After timer expires, executor will be notified and next call to Future::poll shall return Ready, after which all further calls to Future::poll result in Pending without restarting timer.

Usage

 use async_timer::Delay;
 use core::time;

 Delay::platform_new(time::Duration::from_secs(2));

Methods

impl Delay

pub fn platform_new(timeout: Duration) -> Self

Creates new instance using PlatformTimer

impl<T: Timer> Delay<T>

pub fn new(timeout: Duration) -> Self

Creates new instance with specified timeout

Requires to specify Timer type (e.g. Delay::<PlatformTimer>::new())

pub fn restart(&mut self, ctx: &Context)

Restarts underlying Timer.

Comparing to creating Delay the Timer will start counting immediately.

Trait Implementations

impl<T: Timer> Future for Delay<T>

type Output = ()

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

The type of value produced on completion.

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

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

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