Struct timer_kit::Interval

pub struct Interval<D: Delay> { /* private fields */ }

An Interval allows you to wait on a sequence of instants with a certain duration between each instant.

Type Parameter

• D: The underlying timer type that implements the Delay trait

Implementations

impl<D> Interval<D>where
    D: Delay,
    D::Instant: Unpin,

pub fn new(period: Duration) -> Self

Creates new Interval that yields with interval of period. The first tick completes immediately. The default MissedTickBehavior is MissedTickBehavior::Burst, but this can be configured by calling Interval::set_missed_tick_behavior.

Panics

This function will panic if period is zero.

Examples

Creates a new Interval that yields every 100 milliseconds with smol’s timer.

use std::time::Duration;
use timer_kit::Interval;
 
let mut interval = Interval::<smol::Timer>::new(Duration::from_millis(100));
 
interval.tick().await;
interval.tick().await;
interval.tick().await;

Creates a new Interval that yields every 100 milliseconds with fluvio_wasm_timer::Delay.

use std::time::Duration;
use timer_kit::Interval;
 
let mut interval = Interval::<fluvio_wasm_timer::Delay>::new(Duration::from_millis(100));
 
interval.tick().await;
interval.tick().await;
interval.tick().await;

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

Creates new Interval that yields with interval of period with the first tick completing at start. The default MissedTickBehavior is MissedTickBehavior::Burst, but this can be configured by calling Interval::set_missed_tick_behavior.

Panics

This function will panic if period is zero.

Examples

Creates a new Interval that yields every 100 milliseconds with smol’s timer.

use std::time::{Duration, Instant};
use timer_kit::Interval;
 
let mut interval = Interval::<smol::Timer>::new_at(Instant::now(), Duration::from_millis(100));
 
interval.tick().await;
interval.tick().await;
interval.tick().await;

Creates a new Interval that yields every 100 milliseconds with fluvio_wasm_timer::Delay.

use std::time::Duration;
use fluvio_wasm_timer::Instant;
use timer_kit::Interval;
 
let mut interval = Interval::<fluvio_wasm_timer::Delay>::new_at(Instant::now(), Duration::from_millis(100));
 
interval.tick().await;
interval.tick().await;
interval.tick().await;

pub fn missed_tick_behavior(&self) -> MissedTickBehavior

Returns the MissedTickBehavior of the Interval.

pub fn set_missed_tick_behavior(&mut self, behavior: MissedTickBehavior)

Sets the MissedTickBehavior of the Interval.

pub fn period(&self) -> Duration

Returns the period of the Interval.

pub fn poll_tick(&mut self, cx: &mut Context<'_>) -> Poll<D::Value>

Polls the next tick of the Interval.

pub async fn tick(&mut self) -> D::Value

Completes the next tick of the Interval.

pub fn reset(&mut self)

Resets the interval to complete one period after the current time. This method ignores MissedTickBehavior strategy.

Trait Implementations

impl<D> Debug for Interval<D>where
    D: Delay + Debug,
    D::Instant: Debug,

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

Formats the value using the given formatter.

impl<D> Stream for Interval<D>where
    D: Delay,
    D::Instant: Unpin,

type Item = <D as Delay>::Value

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.