Struct Timer 

pub struct Timer { /* private fields */ }

A timer that counts down and knows when a Duration has elapsed

Implementations

impl Timer

pub fn set<D: ToDuration>(time: D) -> Timer

Creates a new Timer

pub fn reset(&mut self)

Resets the Timer

pub fn duration_left(&self) -> Option<Duration>

Gets the time left as a Duration

pub fn seconds_left(&self) -> Seconds

Gets the time left as a floating-point number of seconds

pub fn is_ready(self) -> bool

Checks if the set Duration has elapsed

pub fn as_ready(self) -> Option<Seconds>

Checks if the set Duration has elapsed and returns the elapsed floating-point number of seconds if it has

pub fn max_duration(&self) -> Duration

Gets the time the Timer was originally set with as a Duration

pub fn max_seconds(&self) -> Seconds

Gets the time the Timer was originally set with as a floating-point number of seconds

pub fn seconds(&self) -> Seconds

Gets the elapsed time as a floating-point number of seconds

pub fn duration(&self) -> Duration

Get the elapsed time as a Duration

pub fn started_at(&self) -> Instant

Gets the Instant at which the Timer was started

pub fn ends_at(&self) -> Instant

Gets the Instant at which the Timer will or did end

pub fn tick<F, R>(&mut self, f: F) -> Option<R>

where F: FnMut(Seconds) -> R,

If the timer is ready, runs the given function with the elapsed floating-point number of seconds as a parameter and resets the timer

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Timer

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

Formats the value using the given formatter.

impl Default for Timer

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Timer

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 Ord for Timer

fn cmp(&self, other: &Timer) -> 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 PartialEq for Timer

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Timer

fn partial_cmp(&self, other: &Timer) -> 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 Copy for Timer

impl Eq for Timer

impl StructuralPartialEq for Timer