Struct alass_core::TimePoint

pub struct TimePoint(_);

Represents a timepoint in your own metric.

A timepoint is internally represented by an integer (because the align algorithm needs discrete time steps). You will have to choose your own metric: for example 1i64 means 2ms. The internal algorithm does not use any non-user given TimePoints (so its interpretation is up to you).

This is the reason this library works with TimePoint and TimeDelta: to enforce an absolute and delta relationship an a own metric.

The only way to create a new TimePoint is with TimePoint::from({i64}).

use alass_core::TimePoint;

let p = TimePoint::from(10);

// to get that i64 again
let i1: i64 = p.into();
let i2 = i64::from(p);

Methods

impl TimePoint

pub fn as_f32(self) -> f32

Returns a f32 for the given time point.

pub fn as_f64(self) -> f64

Returns a f32 for the given time point.

pub fn as_i64(self) -> i64

Returns a i64 for the given time point.

Trait Implementations

impl From<i64> for TimePoint

fn from(f: i64) -> TimePoint

Performs the conversion.

impl From<TimePoint> for i64

fn from(t: TimePoint) -> i64

Performs the conversion.

impl Clone for TimePoint

fn clone(&self) -> TimePoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TimePoint

impl Eq for TimePoint

impl Ord for TimePoint

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<TimePoint> for TimePoint

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<TimePoint> for TimePoint

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

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

fn lt(&self, other: &TimePoint) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &TimePoint) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &TimePoint) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &TimePoint) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Display for TimePoint

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

Formats the value using the given formatter.

impl Debug for TimePoint

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

Formats the value using the given formatter.

impl Sub<TimePoint> for TimePoint

type Output = TimeDelta

The resulting type after applying the - operator.

fn sub(self, rhs: TimePoint) -> TimeDelta

Performs the - operation.

impl Sub<TimeDelta> for TimePoint

type Output = TimePoint

The resulting type after applying the - operator.

fn sub(self, rhs: TimeDelta) -> TimePoint

Performs the - operation.

impl Add<TimeDelta> for TimePoint

type Output = TimePoint

The resulting type after applying the + operator.

fn add(self, rhs: TimeDelta) -> TimePoint

Performs the + operation.

impl AddAssign<TimeDelta> for TimePoint

fn add_assign(&mut self, rhs: TimeDelta)

Performs the += operation.

impl SubAssign<TimeDelta> for TimePoint

fn sub_assign(&mut self, rhs: TimeDelta)

Performs the -= operation.

impl Hash for TimePoint

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, 

Feeds a slice of this type into the given [Hasher].