Struct tokio::time::Interval

pub struct Interval { /* fields omitted */ }

This is supported on crate feature time only.

Stream returned by interval and interval_at.

This type only implements the Stream trait if the "stream" feature is enabled.

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

Trait Implementations

impl Debug for Interval

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

Formats the value using the given formatter.

impl Stream for Interval

type Item = Instant

Values yielded by the stream.

fn poll_next(
    mut self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Instant>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

pub fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.