Struct Periodic

pub struct Periodic { /* private fields */ }

Periodic async timer that fires at an interval.

Implements Stream for continuous events and Future for just the next event. The Stream implementation never yields None, so the stream never ends.

Example

use std::time::Duration;
use local_runtime::time::Periodic;
use futures_lite::StreamExt;

let mut periodic = Periodic::periodic(Duration::from_secs(1));
loop {
    // Print to screen once every second
    periodic.next().await;
    println!("One second has passed");
}

Implementations

impl Periodic

pub fn periodic(period: Duration) -> Self

Timer that fires periodically

pub fn periodic_at(start: Instant, period: Duration) -> Self

Timer that fires periodically, starting from a set point in time

pub fn set_period(&mut self, period: Duration)

Change the period of the timer, effective after the next time it fires

Trait Implementations

impl Stream for Periodic

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.