Struct Interval

pub struct Interval { /* private fields */ }

A timer that keeps re-triggering.

Use TimerListener::every, TimerListener::every_hz, TimerListener::every_ms, or TimerListener::every_ticks to get an Interval.

This implements Stream, giving the Duration of time ago when this should have been triggered. If a task takes a lot of time, the Stream will only produce one event. This is likely what you want for handling events like keypad input, as only one event will trigger after blocking for a while, rather than many events being triggered right after the blocking event.

use ndless_async::StreamExt;
use ndless_async::task::{block_on, AsyncListeners};

let listeners = AsyncListeners::new();
block_on(&listeners, async {
    let mut interval = listeners.timer().every_ms(1000);
    while let Some(d) = interval.next().await {
        println!("Ping! This event was expected {:?} ago", d);
    }
});

Implementations

impl Interval

pub fn interval(&self) -> Duration

The interval that this Interval triggers

pub fn interval_ms(&self) -> u32

The interval, in milliseconds, that this Interval triggers

pub fn interval_ticks(&self) -> u32

The interval, in ticks, that this Interval triggers

pub fn reschedule_ms(&mut self, ms: u32)

Reschedules this interval for the specified number of milliseconds. Problems will occur when sleeping for more than 2^31/32768 seconds, which is about 18 hours.

pub fn reschedule(&mut self, dur: Duration)

Reschedules this interval for the specified Duration. Problems will occur when sleeping for more than 2^31/32768 seconds, which is about 18 hours.

This function has a resolution of 30 μs.

pub fn reschedule_ticks(&mut self, ticks: u32)

Reschedules this interval for the specified number of ticks. Problems will occur when sleeping for more than 2^31 ticks, which is about 18 hours.

Trait Implementations

impl Stream for Interval

type Item = Duration

The difference between now and when this event should have occurred.

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.