Enum Instant 

#[repr(C, u8)]
pub enum Instant {
    System(InstantPtr),
    Tick(SystemTick),
}

A point in time, either from the system clock or a tick counter.

Use Instant::System on platforms with std, Instant::Tick on embedded/no_std.

Variants

System(InstantPtr)

System time from std::time::Instant (requires “std” feature)

Tick(SystemTick)

Tick-based time for embedded systems without a real-time clock

Implementations

impl Instant

pub fn now() -> Self

Returns the current system time.

On systems with std, this uses std::time::Instant::now(). On no_std systems, this returns a zero tick.

pub fn linear_interpolate(&self, start: Self, end: Self) -> f32

Returns a number from 0.0 to 1.0 indicating the current linear interpolation value between (start, end)

pub fn add_optional_duration(&self, duration: Option<&Duration>) -> Self

Adds a duration to the instant.

The duration’s UNIT need not match the instant’s: a Tick duration added to a System instant is converted at TICKS_PER_SECOND, and a System duration added to a Tick instant is converted to whole ticks.

Why the mismatch is converted rather than dropped

This used to return self unchanged for a unit mismatch, which turned a Duration::Tick interval on a wall-clock timer into a schedule point of last_run + 0 — Timer::instant_of_next_run is literally last_run + delay + interval, so the timer reported itself permanently overdue and LayoutWindow::time_until_next_timer_ms answered Some(0) for it, i.e. “block for zero milliseconds” to any loop that consults it.

System + System still overflow-panics on an absurd duration (that is StdInstant’s own behaviour, characterised in the tests); the tick arms saturate.

pub fn into_std_instant(self) -> StdInstant

Converts to std::time::Instant (panics if Tick variant).

pub fn duration_since(&self, earlier: &Self) -> Duration

Calculates the duration since an earlier point in time.

Saturates to a zero duration in the degenerate cases (earlier is actually later than self, or the two instants are of mismatched kinds) instead of panicking — this runs on the hot event-loop path and must not crash.

Trait Implementations

impl Clone for Instant

fn clone(&self) -> Instant

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instant

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

Formats the value using the given formatter.

impl Eq for Instant

impl From<Instant> for Instant

Available on crate feature std only.

fn from(s: StdInstant) -> Self

Converts to this type from the input type.

impl Hash for Instant

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 Ord for Instant

fn cmp(&self, other: &Instant) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Instant

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Instant

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

This method returns an ordering between self and other values if one exists.

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 Instant