Struct Duration 

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

A nonnegative span of time, stored as integer flicks.

Negative spans cannot be constructed. Use TimeOffset where a signed displacement is meaningful, such as shifting a clip earlier. Durations add, scale and subtract (panicking below zero, see Duration::checked_sub); they share the tick unit and overflow behavior of Time.

Implementations

impl Duration

pub const ZERO: Self

The empty duration.

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

Constructs a duration 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 negative or nonfinite input or a rounded result beyond the tick range; see Self::try_from_seconds.

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

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

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

Returns the duration from the origin to a frame boundary, with the same ceiling rule as Time::from_frame.

Panics

Panics if the boundary cannot be represented as ticks.

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

Converts a frame boundary like Self::from_frame, returning None on overflow.

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

Returns the frame containing this span’s end, rounding down.

Panics

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

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

Finds the frame count like Self::to_frame, returning None on overflow.

pub fn as_seconds(self) -> f64

Converts to floating-point seconds for animation mathematics.

pub const fn ticks(self) -> u64

Returns the exact tick count.

pub fn after_origin(self) -> Time

Returns the time point this far from the origin.

Panics

Panics if the duration exceeds the signed tick range.

pub fn checked_offset(self) -> Option<TimeOffset>

Returns the signed displacement of this duration, or None beyond the signed tick range.

pub fn offset(self) -> TimeOffset

Returns the signed displacement of this duration, for shifting time later.

Panics

Panics if the duration exceeds the signed tick range; see Self::checked_offset.

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

Subtracts exactly, returning None when other is longer.

pub fn saturating_sub(self, other: Self) -> Self

Subtracts, stopping at Self::ZERO when other is longer.

pub fn checked_mul(self, factor: u64) -> Option<Self>

Multiplies ticks exactly, returning None on overflow.

pub fn try_mul(self, factor: f64) -> Result<Self, ValidationError>

Scales like the * f64 operator, reporting a negative or nonfinite factor and overflow.

pub fn try_div(self, divisor: f64) -> Result<Self, ValidationError>

Divides like the / f64 operator, reporting a negative, nonfinite or zero divisor and overflow.

pub fn try_ratio(self, divisor: Self) -> Result<f64, ValidationError>

Returns the dimensionless ratio, reporting a zero divisor.

Trait Implementations

impl Add for Duration

type Output = Duration

The resulting type after applying the + operator.

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

Performs the + operation.

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 AddAssign for Duration

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AddAssign<Duration> for Time

fn add_assign(&mut self, span: Duration)

Performs the += operation.

impl Clone for Duration

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 Duration

impl Debug for Duration

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

Formats the value using the given formatter.

impl Default for Duration

fn default() -> Self

Returns the “default value” for a type.

impl Div for Duration

fn div(self, divisor: Self) -> f64

Returns a dimensionless ratio.

Panics

Panics for a zero divisor; see Duration::try_ratio.

type Output = f64

The resulting type after applying the / operator.

impl Div<f64> for Duration

fn div(self, divisor: f64) -> Self

Divides the duration.

Panics

Panics for a negative, nonfinite or zero divisor; see Duration::try_div.

type Output = Duration

The resulting type after applying the / operator.

impl Eq for Duration

impl Hash for Duration

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 Mul<Duration> for i32

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, span: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for i64

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, span: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for u32

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, span: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for u64

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, span: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for usize

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, span: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for f64

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, span: Duration) -> Duration

Performs the * operation.

impl Mul<f64> for Duration

fn mul(self, factor: f64) -> Self

Scales the duration and rounds to the nearest tick, away from zero at ties.

Panics

Panics for a negative or nonfinite factor or overflow; see Duration::try_mul.

type Output = Duration

The resulting type after applying the * operator.

impl Mul<i32> for Duration

fn mul(self, factor: i32) -> Duration

Scales exactly.

Panics

Panics for a negative factor or on overflow; see Duration::checked_mul.

type Output = Duration

The resulting type after applying the * operator.

impl Mul<i64> for Duration

fn mul(self, factor: i64) -> Duration

Scales exactly.

Panics

Panics for a negative factor or on overflow; see Duration::checked_mul.

type Output = Duration

The resulting type after applying the * operator.

impl Mul<u32> for Duration

fn mul(self, factor: u32) -> Duration

Scales exactly.

Panics

Panics for a negative factor or on overflow; see Duration::checked_mul.

type Output = Duration

The resulting type after applying the * operator.

impl Mul<u64> for Duration

fn mul(self, factor: u64) -> Duration

Scales exactly.

Panics

Panics for a negative factor or on overflow; see Duration::checked_mul.

type Output = Duration

The resulting type after applying the * operator.

impl Mul<usize> for Duration

fn mul(self, factor: usize) -> Duration

Scales exactly.

Panics

Panics for a negative factor or on overflow; see Duration::checked_mul.

type Output = Duration

The resulting type after applying the * operator.

impl Ord for Duration

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 Duration

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Duration

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 Duration

impl Sub for Duration

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

Subtracts exactly.

Panics

Panics when other is longer; see Duration::checked_sub.

type Output = Duration

The resulting type after applying the - operator.

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 SubAssign for Duration

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl SubAssign<Duration> for Time

fn sub_assign(&mut self, span: Duration)

Performs the -= operation.

impl Sum for Duration

fn sum<Spans: Iterator<Item = Self>>(spans: Spans) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.