Struct gloo_timers::future::IntervalStream

pub struct IntervalStream { /* private fields */ }

A scheduled interval as a Stream.

See IntervalStream::new for scheduling new intervals.

Once scheduled, if you want to stop the interval from continuing to fire, you can drop the stream.

An interval stream will never resolve to Err.

Implementations

impl IntervalStream

pub fn new(millis: u32) -> IntervalStream

Create a new interval stream.

Remember that streams do nothing unless polled or spawned, so either spawn this stream via wasm_bindgen_futures::spawn_local or use it inside another stream or future.

Example

use futures_util::stream::StreamExt;
use gloo_timers::future::IntervalStream;
use wasm_bindgen_futures::spawn_local;

spawn_local(async {
    IntervalStream::new(1_000).for_each(|_| {
        // Do stuff every one second...
    }).await;
});

Trait Implementations

impl Debug for IntervalStream

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

Formats the value using the given formatter.

impl Stream for IntervalStream

type Item = ()

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.