[][src]Struct simpler_timer::Timer

pub struct Timer { /* fields omitted */ }

Timer provides extremely basic timing abilities

Implementations

impl Timer[src]

pub fn new() -> Timer[src]

Creates a new timer of zero Duration.

Similar to std::time::Instant as this is really only useful for getting elapsed time since reset

pub fn with_duration(duration: Duration) -> Timer[src]

Creates a new timer with duration length

pub fn reset(&self)[src]

Resets the timer.

Note

The decision was made intentionally to only require a &self for resetting a timer so that another object can own a Timer and not require &mut self of the object owning the timer.

elapsed() will start over at 0 after a reset()

pub fn expired(&self) -> bool[src]

Check if the timer is expired

expired = elapsed >= duration

pub fn duration(&self) -> Duration[src]

Return a Duration of the configured time of the Timer

pub fn wait(&self)[src]

Block execution until the timer expires.

  • If the timer is already expired, this returns immediately

pub fn elapsed(&self) -> Duration[src]

Get Duration of time elapsed since Timer reset

Note

A newly constructed timer is considered to be reset

Trait Implementations

impl Clone for Timer[src]

impl Debug for Timer[src]

Auto Trait Implementations

impl !RefUnwindSafe for Timer

impl Send for Timer

impl !Sync for Timer

impl Unpin for Timer

impl UnwindSafe for Timer

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.