Enum async_timer::Interval

#[must_use = "Interval does nothing unless polled"]
pub enum Interval<T = PlatformTimer> {
    // some variants omitted
}

Periodic Timer

On each completition user receives new instance that can be polled once again

Note

Returned Interval is already armed, so it don't need initial poll to start over.

Usage

#![feature(async_await)]

async fn job() {
}

async fn do_a_while() {
    let mut times: u8 = 0;
    let mut interval = async_timer::Interval::platform_new(core::time::Duration::from_secs(1));

    while times < 5 {
        job().await;
        interval = interval.await;
        times += 1;
    }
}

Methods

impl Interval

pub fn platform_new(interval: Duration) -> Self

Creates new instance using platform timer

impl<T: Oneshot> Interval<T>

pub fn new(interval: Duration) -> Self

Creates new instance with specified timer type.

Trait Implementations

impl<T: Oneshot> Future for Interval<T>

type Output = Self

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, ctx: &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.