Struct Transform

pub struct Transform<Reference, Output> {
    pub reference_offset: Instant<Reference>,
    pub synthetic_offset: Instant<Output>,
    pub rate_adjust_ppm: i32,
    pub error_bound_at_offset: u64,
    pub error_bound_growth_ppm: u32,
}

A transformation from monotonic time to synthetic time, including an error bound on this synthetic time.

Fields

reference_offset: Instant<Reference>

An offset on the monotonic timeline in nanoseconds.

synthetic_offset: Instant<Output>

An offset on the synthetic timeline in nanoseconds.

rate_adjust_ppm: i32

An adjustment to the standard 1 monotonic tick:1 synthetic tick rate in parts per million. Positive values indicate the synthetic clock is moving faster than the monotonic clock.

error_bound_at_offset: u64

The error bound on synthetic clock at monotonic = monotonic_offset.

error_bound_growth_ppm: u32

The growth in error bound per monotonic tick in parts per million.

Implementations

impl<Reference: Timeline + Copy, Output: Timeline + Copy> Transform<Reference, Output>

pub fn synthetic(&self, reference: Instant<Reference>) -> Instant<Output>

Returns the synthetic time at the supplied monotonic time.

pub fn error_bound(&self, reference: Instant<Reference>) -> u64

Returns the error bound at the supplied monotonic time.

pub fn difference( &self, other: &Self, reference: Instant<Reference>, ) -> Duration<Output>

Returns the synthetic time on this Transform minus the synthetic time on other, calculated at the supplied monotonic time.

pub fn jump_to( &self, reference: Instant<Reference>, ) -> ClockUpdate<Reference, Output>

Returns a ClockUpdate that will set a Clock onto this Transform using data from the supplied monotonic time.

Trait Implementations

impl<Reference: Clone, Output: Clone> Clone for Transform<Reference, Output>

fn clone(&self) -> Transform<Reference, Output>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Reference: Debug, Output: Debug> Debug for Transform<Reference, Output>

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

Formats the value using the given formatter.

impl<Reference: Default, Output: Default> Default for Transform<Reference, Output>

fn default() -> Transform<Reference, Output>

Returns the “default value” for a type.

impl<Reference: Timeline, Output: Timeline> From<&Clock<Reference, Output>> for Transform<Reference, Output>

fn from(clock: &Clock<Reference, Output>) -> Self

Converts to this type from the input type.

impl<Reference: PartialEq, Output: PartialEq> PartialEq for Transform<Reference, Output>

fn eq(&self, other: &Transform<Reference, Output>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Reference: Eq, Output: Eq> Eq for Transform<Reference, Output>

impl<Reference, Output> StructuralPartialEq for Transform<Reference, Output>