Enum PeriodicTimer

pub enum PeriodicTimer {
    Started(Interval),
    Stopped,
}

PeriodicTimer expires on given interval

PeriodicTimer is an extension and built on top of tokio::time::Interval. It can be in two states: PeriodicTimer::Started and PeriodicTimer::Stopped. When in PeriodicTimer::Started state the timer will expire every interval duration but when in PeriodicTimer::Stopped it won’t expire until the timer is started again.

use async_timers::PeriodicTimer;
use tokio::time::{Duration, timeout};

#[tokio::main]
async fn main() {
    let mut timer = PeriodicTimer::started(Duration::from_millis(10));

    timer.tick().await;
    timer.tick().await;
    timer.tick().await;

    // approximately 30ms have elapsed.

    let result = timeout(Duration::from_millis(100), timer.tick()).await;
    assert!(result.is_ok(), "Timeout should not occur since timer is running");

    timer.stop();

    let result = timeout(Duration::from_millis(100), timer.tick()).await;
    assert!(result.is_err(), "Timeout should occur since timer is stopped");
}

Variants

Started(Interval)

Stopped

Implementations

impl PeriodicTimer

pub fn started(period: Duration) -> Self

Create started timer with the given period

pub fn stopped() -> Self

Create stopped timer

pub fn start(&mut self, period: Duration)

Start the timer with given period

pub fn stop(&mut self)

Stop the timer

pub async fn tick(&mut self) -> Instant

Returns a Future that will expire based on timer’s state

Trait Implementations

impl Debug for PeriodicTimer

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

Formats the value using the given formatter.

impl Default for PeriodicTimer

fn default() -> PeriodicTimer

Returns the “default value” for a type.