Struct tokio::time::Interval

pub struct Interval { /* fields omitted */ }

Stream returned by interval and interval_at.

Methods

impl Interval

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

Completes when the next instant in the interval has been reached.

Examples

use tokio::time;

use std::time::Duration;

#[tokio::main]
async fn main() {
    let mut interval = time::interval(Duration::from_millis(10));

    interval.tick().await;
    interval.tick().await;
    interval.tick().await;

    // approximately 20ms have elapsed.
}

Trait Implementations

impl Debug for Interval

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

Formats the value using the given formatter.