Struct ClockRate

pub struct ClockRate { /* private fields */ }

Time measuring device. Uses system monotonic clock counter and yields ClockSteps for each step.

Rate can be set to control the speed of the clock.

Implementations

impl ClockRate

pub fn new() -> Self

Returns new ClockRate instance.

pub fn reset(&mut self)

Resets the clock. Sets start to the given instant. And set clocks to start.

pub fn set_now(&mut self, now: TimeStamp)

Sets current clock time to given time stamp.

pub fn with_now(self, now: TimeStamp) -> Self

Sets current clock time to given time stamp.

pub fn now(&self) -> TimeStamp

Returns time stamp corresponding to “now” of the last step.

pub fn set_rate(&mut self, rate: f32)

Set rate to specified float value.

pub fn with_rate(self, rate: f32) -> Self

Set rate to specified float value.

pub fn rate(&self) -> f64

Returns current rate.

pub fn set_rate_ratio(&mut self, nom: u64, denom: NonZeroU64)

Set rate to specified ratio.

pub fn with_rate_ratio(self, nom: u64, denom: NonZeroU64) -> Self

Set rate to specified ratio.

pub fn rate_ratio(&mut self) -> (u64, NonZeroU64)

Returns current rate ratio.

pub fn pause(&mut self)

Set rate to 0.

pub fn step(&mut self, span: TimeSpan) -> ClockStep

Advances the clock by given time span and returns ClockStep result. with new time stamp and time span since previous step.

pub fn ticker(&self, freq: Frequency) -> FrequencyTicker

Trait Implementations

impl Clone for ClockRate

fn clone(&self) -> ClockRate

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ClockRate

fn default() -> Self

Returns the “default value” for a type.