Struct statime::OverlayClock

pub struct OverlayClock<C: Clock> { /* private fields */ }

An overlay over other, read-only clock, frequency-locked to it. In other words, a virtual clock which can be tuned in software without affecting the underlying system or hardware clock.

Implementations

impl<C: Clock> OverlayClock<C>

pub fn new(underlying_clock: C) -> Self

Creates new OverlayClock based on given clock

pub fn time_from_underlying(&self, roclock_time: Time) -> Time

Converts (shifts and scales) Time in underlying clock’s timescale to overlay clock timescale

pub fn underlying(&self) -> &C

Returns reference to underlying clock

Trait Implementations

impl<C: Clock> Clock for OverlayClock<C>

type Error = <C as Clock>::Error

Type of the error the methods of this Clock may return

fn now(&self) -> Time

Get the current time of the clock

fn set_frequency(&mut self, ppm: f64) -> Result<Time, Self::Error>

Set the frequency of the clock, returning the time at which the change was applied. The value is in ppm difference from the clocks base frequency.

fn step_clock(&mut self, offset: Duration) -> Result<Time, Self::Error>

Change the current time of the clock by offset. Returns the time at which the change was applied.

fn set_properties( &mut self, _time_properties_ds: &TimePropertiesDS, ) -> Result<(), Self::Error>

Adjust the timescale properties of the clock, including things like the leap indicator, to the extend supported by the system.

impl<C: Debug + Clock> Debug for OverlayClock<C>

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

Formats the value using the given formatter.