Struct FrequencyTicker

pub struct FrequencyTicker { /* private fields */ }

Ticker with the given frequency.

Creates tick iterators on each step that emits ClockSteps with exactly given frequency.

Implementations

impl FrequencyTicker

pub fn new(freq: Frequency, now: TimeStamp) -> Self

Creates new ticker with given frequency and start timestamp.

pub fn with_delay(freq: Frequency, periods: u64, now: TimeStamp) -> Self

Creates new ticker with given frequency and delay in number of tick periods.

pub fn next_tick(&self) -> Option<TimeStamp>

Returns next timestamp when next tick will happen.

pub fn ticks(&mut self, step: TimeSpan) -> FrequencyTickerIter

Advances ticker forward for span and returns iterator over ticks since last advancement.

pub fn tick_count(&mut self, step: TimeSpan) -> u64

Advances ticker forward to now and returns number of ticks since last advancement.

pub fn with_ticks(&mut self, step: TimeSpan, f: impl FnMut(ClockStep))

Advances ticker forward for step and calls provided closure with ClockSteps.

pub fn frequency(&self) -> Frequency

Returns frequency of the ticker.

pub fn set_frequency(&mut self, freq: Frequency, clip_period: bool)

Sets new frequency of the ticker.

If clip_period is true, then next tick will happen at least in the frequency period. If clip_period is false, then next tick will happen at the same time as before setting the frequency.