Struct ClockTimer

pub struct ClockTimer { /* private fields */ }

An interval tracking clock. Takes a start time, an end time or a run duration, and an interval. Calls to tick will return only if the current time is at or past the time of the next interval, waiting so that it is before returning. It yields timing information when returning. If this falls behind time for some reason, the ticks will be yielded with the time information at when it was supposed to yield, until catching up.

Implementations

impl ClockTimer

pub fn builder() -> Builder

Gets a ClockTimer builder

pub async fn tick(&mut self) -> Option<Tick>

Runs the next tick and returns timing information for it, if this interval is not finished already.

pub async fn run_to_end<F, Fu>(self, f: F)

where F: FnMut(Tick) -> Fu, Fu: Future<Output = ()>,

Convenience function, equivalent to running a while let Some(tick) loop. When awaited on, the closure provided will be called every tick. This consumes self and runs it to completion.