Struct tokio::time::Interval

pub struct Interval { /* private fields */ }

Interval returned by interval and interval_at.

This type allows you to wait on a sequence of instants with a certain duration between each instant. Unlike calling sleep in a loop, this lets you count the time spent between the calls to sleep as well.

An Interval can be turned into a Stream with IntervalStream.

Implementations

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.
}

pub fn poll_tick(&mut self, cx: &mut Context<'_>) -> Poll<Instant>

Poll for the next instant in the interval to be reached.

This method can return the following values:

• Poll::Pending if the next instant has not yet been reached.
• Poll::Ready(instant) if the next instant has been reached.

When this method returns Poll::Pending, the current task is scheduled to receive a wakeup when the instant has elapsed. Note that on multiple calls to poll_tick, only the Waker from the Context passed to the most recent call is scheduled to receive a wakeup.

pub fn period(&self) -> Duration

Returns the period of the interval.

Trait Implementations

impl Debug for Interval

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

Formats the value using the given formatter.