Struct eggtimer::EggTimer

pub struct EggTimer { /* fields omitted */ }

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

Implementations

impl EggTimer

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

Creates a new EggTimer

pub fn reset(&mut self)

Resets the EggTimer

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

Gets the time left as a Duration

pub fn seconds_left(&self) -> f64

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<f64>

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 EggTimer was originally set with as a Duration

pub fn max_seconds(&self) -> f64

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

pub fn elapsed(&self) -> f64

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 EggTimer was started

pub fn ends_at(&self) -> Instant

Gets the Instant at which the EggTimer will or did end

pub fn tick<F, R>(&mut self, f: F) -> Option<R> where
    F: FnMut(f64) -> 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 EggTimer

fn clone(&self) -> EggTimer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EggTimer

impl Debug for EggTimer

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

Formats the value using the given formatter.

impl Eq for EggTimer

impl Hash for EggTimer

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].

impl Ord for EggTimer

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]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<EggTimer> for EggTimer

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

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

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

This method tests for !=.

impl PartialOrd<EggTimer> for EggTimer

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for EggTimer

impl StructuralPartialEq for EggTimer