Struct TimeOffset 

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

A signed span of time, stored as integer flicks.

Unlike Duration, an offset may be negative. It is the result of Time - Time and the type of clip offsets and similar shifts. Arithmetic panics on overflow, independently of the build profile.

Implementations

impl TimeOffset

pub const ZERO: Self

The empty offset.

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

Constructs an offset 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 const fn ticks(self) -> i64

Returns the exact signed tick count.

pub fn as_seconds(self) -> f64

Converts to floating-point seconds for animation mathematics.

pub const fn is_negative(self) -> bool

Returns true when the offset moves toward earlier time.

pub const fn magnitude(self) -> Duration

Returns the length of the offset without its sign.

pub const fn to_duration(self) -> Option<Duration>

Returns the offset as a duration, or None when it is negative.

Trait Implementations

impl Add for TimeOffset

type Output = TimeOffset

The resulting type after applying the + operator.

fn add(self, other: Self) -> 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 for TimeOffset

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AddAssign<TimeOffset> for Time

fn add_assign(&mut self, offset: TimeOffset)

Performs the += operation.

impl Clone for TimeOffset

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 TimeOffset

impl Debug for TimeOffset

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

Formats the value using the given formatter.

impl Default for TimeOffset

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TimeOffset

impl Hash for TimeOffset

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 Neg for TimeOffset

type Output = TimeOffset

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for TimeOffset

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 TimeOffset

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TimeOffset

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 TimeOffset

impl Sub for TimeOffset

type Output = TimeOffset

The resulting type after applying the - operator.

fn sub(self, other: Self) -> 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 for TimeOffset

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl SubAssign<TimeOffset> for Time

fn sub_assign(&mut self, offset: TimeOffset)

Performs the -= operation.