Struct runtime::time::Interval

#[must_use = "streams do nothing unless polled"]
pub struct Interval { /* fields omitted */ }

A stream representing notifications at a fixed interval.

Methods

impl Interval

pub fn new(dur: Duration) -> Self

Create a stream that fires events at a set interval.

Examples

use runtime::time::Interval;
use std::time::{Duration, Instant};

let start = Instant::now();
let mut interval = Interval::new(Duration::from_millis(10)).take(3);
while let Some(now) = interval.next().await {
    println!("{}ms have elapsed", (now - start).as_millis());
}

assert!(Instant::now() - start >= Duration::from_millis(30));

Trait Implementations

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 Self>, cx: &mut Context) -> Poll<Option<Self::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.

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

Returns the bounds on the remaining length of the stream.