Struct tokio::timer::Interval

pub struct Interval { /* fields omitted */ }

A stream representing notifications at fixed interval

Methods

impl Interval

pub fn new(at: Instant, duration: Duration) -> Interval

Create a new Interval that starts at at and yields every duration interval after that.

Note that when it starts, it produces item too.

The duration argument must be a non-zero duration.

Panics

This function panics if duration is zero.

pub fn new_interval(duration: Duration) -> Interval

Creates new Interval that yields with interval of duration.

The function is shortcut for Interval::new(tokio_timer::clock::now() + duration, duration).

The duration argument must be a non-zero duration.

Panics

This function panics if duration is zero.

pub fn next(&'_ mut self) -> impl Future<Output = Option<Instant>>

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

Examples

use tokio::timer::Interval;

use std::time::Duration;

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

    interval.next().await;
    interval.next().await;
    interval.next().await;

    // approximately 30ms have elapsed.
}

Trait Implementations

impl FusedStream for Interval

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl Debug for Interval

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

Formats the value using the given formatter.

impl Stream for Interval

type Item = Instant

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Interval>,
    cx: &mut Context
) -> Poll<Option<<Interval as Stream>::Item>>

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.