Struct Ticks 

pub struct Ticks<T: Timeline> { /* private fields */ }

A distance between two points on timeline T, in its ticks. Signed, because the later point may be on either side.

Implementations

impl<T: Timeline> Ticks<T>

pub const ZERO: Self

No distance.

pub const fn new(count: i64) -> Self

count ticks of timeline T.

pub const fn count(self) -> i64

The count of ticks, negative for a distance backwards.

pub const fn is_negative(self) -> bool

Whether the distance is backwards.

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

The distance as a Duration, or None if it is negative, since a Duration cannot be. A tick shorter than a nanosecond is truncated towards zero.

pub fn abs_duration(self) -> Duration

The distance’s length as a Duration, whichever way it points. Truncated towards zero below a nanosecond.

Examples found in repository

examples/clock_costs/main.rs (line 107)

fn clock_nanos<C: Clock>(clock: &C) -> u128 {
    let since_zero = clock.now() - TimePoint::from_ticks(0);
    since_zero.abs_duration().as_nanos()
}

pub fn from_duration(duration: Duration) -> Option<Self>

duration in ticks of T, truncated towards zero, or None if it does not fit.

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

The sum, or None on overflow.

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

The difference, or None on overflow.

pub fn checked_neg(self) -> Option<Self>

The distance the other way, or None for the one count that has no opposite.

Trait Implementations

impl<T: Timeline> Add for Ticks<T>

type Output = Ticks<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Timeline> Add<Ticks<T>> for TimePoint<T>

type Output = TimePoint<T>

The resulting type after applying the + operator.

fn add(self, ticks: Ticks<T>) -> Self

Performs the + operation.

impl<T: Timeline> AddAssign for Ticks<T>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: Timeline> AddAssign<Ticks<T>> for TimePoint<T>

fn add_assign(&mut self, ticks: Ticks<T>)

Performs the += operation.

impl<T: Timeline> Clone for Ticks<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Timeline> Copy for Ticks<T>

impl<T: Timeline> Debug for Ticks<T>

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

Formats the value using the given formatter.

impl<T: Timeline> Default for Ticks<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Timeline> Eq for Ticks<T>

impl<T: Timeline> Hash for Ticks<T>

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<T: Timeline> Neg for Ticks<T>

type Output = Ticks<T>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: Timeline> Ord for Ticks<T>

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<T: Timeline> PartialEq for Ticks<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: Timeline> PartialOrd for Ticks<T>

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<T: Timeline> Sub for Ticks<T>

type Output = Ticks<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Timeline> Sub<Ticks<T>> for TimePoint<T>

type Output = TimePoint<T>

The resulting type after applying the - operator.

fn sub(self, ticks: Ticks<T>) -> Self

Performs the - operation.

impl<T: Timeline> SubAssign for Ticks<T>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T: Timeline> SubAssign<Ticks<T>> for TimePoint<T>

fn sub_assign(&mut self, ticks: Ticks<T>)

Performs the -= operation.