Struct MonotonicInstant 

pub struct MonotonicInstant { /* private fields */ }

A fixed point in one monotonic clock domain.

Instants from different domains cannot be ordered or used in arithmetic together. The value carries the full precision available through Duration without claiming any particular hardware timer resolution.

Discarding a sampled instant is rejected when unused_must_use is denied:

#![deny(unused_must_use)]
use qubit_clock::{ManualMonotonicClock, MonotonicClock};

ManualMonotonicClock::new().now();

Implementations

impl MonotonicInstant

pub const fn new(domain: ClockDomain, elapsed: Duration) -> Self

Creates an instant for a clock implementation.

Parameters

• domain - Identifier of the originating clock.
• elapsed - Duration measured from that clock’s private origin.

Returns

An instant scoped to domain at elapsed.

pub const fn domain(self) -> ClockDomain

Returns the identifier of the originating monotonic clock domain.

Returns

The domain carried by this instant.

pub const fn elapsed_since_origin(self) -> Duration

Returns the elapsed duration from this clock domain’s origin.

The value is meaningful only inside the domain identified by domain().

Returns

The duration from the originating clock’s private origin.

pub fn checked_add(self, duration: Duration) -> Result<Self, TimeError>

Adds a duration while preserving the originating clock domain.

Returns TimeError::InstantOverflow when the result cannot be represented by Duration.

Parameters

• duration - Duration to add to this instant.

Returns

A same-domain instant advanced by duration.

Errors

Returns TimeError::InstantOverflow when the elapsed duration cannot represent the result.

pub fn duration_since(self, earlier: Self) -> Result<Duration, TimeError>

Calculates the duration elapsed since an earlier instant.

Returns TimeError::ClockDomainMismatch when earlier belongs to a different clock, and TimeError::InvalidInstantOrder when earlier is later than this instant.

Parameters

• earlier - Earlier instant expected to belong to the same domain.

Returns

The elapsed duration from earlier to this instant.

Errors

Returns TimeError::ClockDomainMismatch for a foreign instant. Returns TimeError::InvalidInstantOrder when earlier is later, retaining both elapsed durations.

pub fn validate_domain( self, expected_domain: ClockDomain, ) -> Result<(), TimeError>

Verifies that this instant belongs to expected_domain.

Custom monotonic clocks and timers can use this method to reject externally supplied instants before performing domain-specific work.

Parameters

• expected_domain - Domain the instant must belong to.

Returns

Ok(()) when the domains match.

Errors

Returns TimeError::ClockDomainMismatch when the domains differ.

Trait Implementations

impl Clone for MonotonicInstant

fn clone(&self) -> MonotonicInstant

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MonotonicInstant

impl Debug for MonotonicInstant

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

Formats the value using the given formatter.

impl Eq for MonotonicInstant

impl Hash for MonotonicInstant

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MonotonicInstant

fn eq(&self, other: &MonotonicInstant) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MonotonicInstant

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

Orders two instants only when they belong to the same clock domain.

Parameters

• other - Instant to compare with this one.

Returns

Their elapsed-time ordering for a shared domain, or None for distinct domains.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for MonotonicInstant