Struct Duration 

pub struct Duration<R: Rate>(/* private fields */);

A span of ticks at rate R.

The count wraps after 2^32 ticks, which is twelve days at 4096 Hz and months below that. Nothing here allows for that: a span measured across the wrap comes back wrong rather than saturated, so a machine left running that long after Timer::start reads the wrong time.

Implementations

impl<R: Rate> Duration<R>

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

A span of ticks.

pub const fn from_ms(ms: u32) -> Self

The shortest span of at least ms milliseconds.

Rounded up to a whole tick, so comparing against this is the answer to “has ms passed”. At 16 Hz a tick is 63 ms, and nothing shorter can be told apart.

pub const fn ticks(self) -> u32

The span in ticks.

pub fn ms(self) -> u32

The span in milliseconds, rounded down.

Do not compare against this. It multiplies, and that is not cheap enough to run each time a program asks whether a span has passed. from_ms converts at compile time instead, leaving a plain comparison on ticks:

if elapsed >= Duration::from_ms(5000) { .. }   // one comparison
if elapsed.ms() >= 5000 { .. }                 // a multiply first

This is for a number to show or to log.

Trait Implementations

impl<R: Rate> Add for Duration<R>

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

The two spans one after the other, saturating rather than wrapping.

type Output = Duration<R>

The resulting type after applying the + operator.

impl<'a, R: Rate> Add<Duration<R>> for Instant<'a, R>

type Output = Instant<'a, R>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<R: Rate> Clone for Duration<R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Rate> Copy for Duration<R>

impl<R: Rate> Eq for Duration<R>

impl<R: Rate> Ord for Duration<R>

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.

impl<R: Rate> PartialEq for Duration<R>

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

Equality operator ==.

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

Inequality operator !=.

impl<R: Rate> PartialOrd for Duration<R>

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<R: Rate> Sub for Duration<R>

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

What is left of this span after other, or nothing if other is the longer of the two.

type Output = Duration<R>

The resulting type after applying the - operator.

impl<'a, R: Rate> Sub<Duration<R>> for Instant<'a, R>

type Output = Instant<'a, R>

The resulting type after applying the - operator.

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

Performs the - operation.