Struct Interval 

pub struct Interval { /* private fields */ }

A structure that ticks at regular intervals.

Implementations

impl Interval

pub fn new(period: Duration, time_fn: fn() -> Duration) -> Self

Creates a new Interval that ticks at the specified period.

The first tick completes immediately (burst strategy), similar to Tokio.

Examples found in repository

examples/interval.rs (line 18)

fn main() {
    let spawner: ato::Spawner<2> = ato::Spawner::default();
    let start_time = get_platform_time();
    // Run interval task for 3 iterations (500 ms), with sleep in between, which
    // should still be 1500 ms total.
    ato::spawn_task!(spawner, res, {
        let mut interval =
            ato::interval::Interval::new(Duration::from_millis(500), get_platform_time);
        for _ in 0..3 {
            interval.tick().await;
            // sleep for random duration less than the interval
            ato::sleep(Duration::from_millis(200), get_platform_time).await;
        }
    });
    assert!(res.is_ok());
    assert!(spawner.run_until_all_done().is_ok());

    let elapsed = get_platform_time() - start_time;
    assert!(elapsed <= Duration::from_millis(1550)); // with some margin
}

pub fn tick(&mut self) -> IntervalTick<'_>

Creates a future that completes when the next interval is reached.

The returned future borrows the interval, allowing the Interval to track state across multiple calls.

Examples found in repository

examples/interval.rs (line 20)

fn main() {
    let spawner: ato::Spawner<2> = ato::Spawner::default();
    let start_time = get_platform_time();
    // Run interval task for 3 iterations (500 ms), with sleep in between, which
    // should still be 1500 ms total.
    ato::spawn_task!(spawner, res, {
        let mut interval =
            ato::interval::Interval::new(Duration::from_millis(500), get_platform_time);
        for _ in 0..3 {
            interval.tick().await;
            // sleep for random duration less than the interval
            ato::sleep(Duration::from_millis(200), get_platform_time).await;
        }
    });
    assert!(res.is_ok());
    assert!(spawner.run_until_all_done().is_ok());

    let elapsed = get_platform_time() - start_time;
    assert!(elapsed <= Duration::from_millis(1550)); // with some margin
}

pub fn reset(&mut self)

Resets the interval to start ticking from the current instant.

This is useful if the system was paused or lagged significantly and you want to skip the “burst” of missed ticks.

Trait Implementations

impl Debug for Interval

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

Formats the value using the given formatter.