Struct Time 

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

A signed point on the timeline, stored as integer flicks since the origin.

Comparisons and frame conversion use integers. Floating-point seconds are intended for animation mathematics, not interval membership checks. Only meaningful operations exist: Time - Time is a signed TimeOffset, and Time ± Duration or Time ± TimeOffset is a Time. Arithmetic panics on overflow, independently of the build profile.

Implementations

impl Time

pub const ZERO: Self

The time origin.

pub const fn from_ticks(ticks: i64) -> Self

Constructs time without losing integer tick precision.

pub fn from_seconds(seconds: f64) -> Self

Rounds seconds to the nearest tick; halfway cases round away from zero.

Panics

Panics for nonfinite input or a rounded result outside the signed range; see Self::try_from_seconds.

pub fn try_from_seconds(seconds: f64) -> Result<Self, ValidationError>

Rounds seconds like Self::from_seconds, reporting nonfinite or out-of-range input.

pub fn from_frame(frame: i64, rate: FrameRate) -> Self

Returns the first tick at or after the exact rational frame boundary.

Common integer and NTSC rates have exact tick boundaries. Other rates round toward positive infinity by less than one tick, including before zero. Compute each boundary directly; multiplying a rounded frame duration would accumulate drift. Frame indices round-trip through Self::to_frame when the rate does not exceed one frame per tick.

Panics

Panics if the boundary cannot be represented as signed ticks.

pub fn checked_from_frame(frame: i64, rate: FrameRate) -> Option<Self>

Converts a frame boundary with the same ceiling rule as from_frame. Returns None instead of panicking when signed ticks would overflow.

pub fn to_frame(self, rate: FrameRate) -> i64

Returns the containing frame, rounding toward negative infinity.

Panics

Panics if the frame index is outside the signed 64-bit range.

pub fn checked_to_frame(self, rate: FrameRate) -> Option<i64>

Finds the containing frame using integer floor division. Returns None instead of panicking when the frame index would overflow.

pub fn as_seconds(self) -> f64

Converts to floating-point seconds for animation mathematics.

pub const fn ticks(self) -> i64

Returns the exact signed tick count.

pub const fn since_origin(self) -> TimeOffset

Returns the signed displacement from the origin to this time point.

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

Returns the span since an earlier time point, or None when earlier is later.

pub fn checked_add(self, span: Duration) -> Option<Self>

Adds a duration, returning None on signed overflow.

pub fn checked_sub(self, span: Duration) -> Option<Self>

Subtracts a duration, returning None on signed overflow.

Trait Implementations

impl Add<Duration> for Time

type Output = Time

The resulting type after applying the + operator.

fn add(self, span: Duration) -> Self

Performs the + operation.

impl Add<TimeOffset> for Time

type Output = Time

The resulting type after applying the + operator.

fn add(self, offset: TimeOffset) -> Self

Performs the + operation.

impl AddAssign<Duration> for Time

fn add_assign(&mut self, span: Duration)

Performs the += operation.

impl AddAssign<TimeOffset> for Time

fn add_assign(&mut self, offset: TimeOffset)

Performs the += operation.

impl Clone for Time

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 Time

impl Debug for Time

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

Formats the value using the given formatter.

impl Default for Time

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Time

impl Hash for Time

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 Time

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 Time

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Time

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 Time

impl Sub for Time

type Output = TimeOffset

The resulting type after applying the - operator.

fn sub(self, other: Self) -> TimeOffset

Performs the - operation.

impl Sub<Duration> for Time

type Output = Time

The resulting type after applying the - operator.

fn sub(self, span: Duration) -> Self

Performs the - operation.

impl Sub<TimeOffset> for Time

type Output = Time

The resulting type after applying the - operator.

fn sub(self, offset: TimeOffset) -> Self

Performs the - operation.

impl SubAssign<Duration> for Time

fn sub_assign(&mut self, span: Duration)

Performs the -= operation.

impl SubAssign<TimeOffset> for Time

fn sub_assign(&mut self, offset: TimeOffset)

Performs the -= operation.