Struct ticktock::clock::Clock

pub struct Clock { /* fields omitted */ }

Clock structure.

Methods

impl Clock

pub fn new(tick_len: Duration) -> Clock

Creates a new clock.

Create a clock with a tick size of tick_len_ms, in ms.

pub fn new_with_start_time(tick_len: Duration, start: Instant) -> Clock

Creates a new clock with a specified start time

pub fn framerate(fps: f64) -> Clock

Creates a new fixed-framerate clock

pub fn framerate_with_start_time(fps: f64, start: Instant) -> Clock

Creates a new fixed-framerate clock with a specified sart time

pub fn synced(&self, tick_len: Duration) -> Clock

Creates a new clock with a different tick length that is synced to the original clock

pub fn started_at(&self) -> Instant

Get start time

pub fn tick_num_at(&self, now: Instant) -> u128

Returns the tick number preceding an specific instant in time

pub fn wait_until_tick(&self) -> (u128, Instant)

Waits for the next clock tick.

Will wait until the next tick and return the current tick count.

Important traits for ClockIter<'a>

impl<'a> Iterator for ClockIter<'a> type Item = (u128, Instant);

pub fn iter(&self) -> ClockIter

Creates a clock iterator.

The iterator will iterate forever, calling wait_until_tick on each iteration. It will panic after about 293 years.

Returns (current tick number, absolute time) on each iteration, where absolute time is relative to a fixed offset that depends on the machine (see Instant).

Important traits for ClockIterRelative<'a>

impl<'a> Iterator for ClockIterRelative<'a> type Item = (u128, Duration);

pub fn rel_iter(&self) -> ClockIterRelative

Create a relative clock iterator.

Similar to iter(), but the resulting iterator will return a tuple of (current tick number, relative time), with relative time being a time::Duration from the start of the clock.