Struct FrameTime 

pub struct FrameTime(/* private fields */);

A point in time supplied by the shell, in monotonic nanoseconds.

The origin is arbitrary and shell-specific (desktop: nanos since a shell-owned epoch; Android: a Choreographer frame nanos value; iOS: a CADisplayLink timestamp). Widgets may therefore only difference two FrameTimes (via FrameTime::saturating_sub) — never interpret one absolutely, and never compare FrameTimes produced by different shells.

FrameTime::ZERO is the documented “no time available” fallback used by legacy/test paint paths that don’t thread a real clock.

Implementations

impl FrameTime

pub const ZERO: FrameTime

The zero instant — also the “no time available” fallback (see the type docs). Differencing against it yields the raw nanosecond value.

pub const fn from_nanos(nanos: u64) -> Self

Build a FrameTime from a raw monotonic-nanosecond count.

pub const fn as_nanos(self) -> u64

The raw monotonic-nanosecond count. Meaningful only relative to another FrameTime from the same shell (see the type docs).

pub fn as_secs_f64(self) -> f64

This instant as fractional seconds from the (arbitrary) origin. Only differences of two such values carry meaning.

pub fn saturating_sub(self, earlier: FrameTime) -> Duration

The non-negative Duration elapsed from earlier to self.

Saturates at zero when self < earlier (a non-monotonic or reordered clock), so a widget differencing two frame times can never observe a negative delta — the basis of AnimationController::advance’s clamp-and-never-panic guarantee.

Trait Implementations

impl Clone for FrameTime

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FrameTime

impl Debug for FrameTime

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

Formats the value using the given formatter.

impl Default for FrameTime

fn default() -> Self

Returns the “default value” for a type.

impl Eq for FrameTime

impl Hash for FrameTime

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 FrameTime

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for FrameTime

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FrameTime

fn partial_cmp(&self, other: &Self) -> 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 FrameTime