Struct rusty_time::Timer

pub struct Timer { /* private fields */ }

A simple timer that is externally driven. .tick() must be called with a delta time for the timer to advance.

Use it in a loop like this:

use std::time::{Duration, Instant};

use rusty_time::Timer;

fn main() {
    let mut timer = Timer::new(Duration::from_secs_f32(1.5));

    let mut start_time = Instant::now();
    loop {
        timer.tick(start_time.elapsed());
        start_time = Instant::now();
        println!(
            "Time on timer: {:.2}s ({:.1}%)",
            timer.remaining().as_secs_f32(),
            timer.percent_left() * 100.0
        );
        if timer.just_finished() {
            break;
        }
    }
    println!("Timer finished!");
}

Implementations

impl Timer

pub fn new(duration: Duration) -> Self

Create a new timer with the given duration

pub fn tick(&mut self, delta: Duration) -> &mut Self

Advance the timer by a specific duration. This must be called for the timer to be useful.

pub fn just_finished(&self) -> bool

Whether the timer hit zero since the last call to tick.

pub fn finished(&self) -> bool

Whether the timer is at zero.

pub fn reset(&mut self)

Reset the timer to the starting duration. Resets finished and just_finished as well.

pub fn percent(&self) -> f32

Returns percent of timer elapsed (from 0.0 to 1.0)

pub fn percent_left(&self) -> f32

Returns percent of timer remaining (from 1.0 to 0.0)

pub fn duration(&self) -> Duration

Returns the full duration of the timer when newly started. See also remaining and elapsed

pub fn set_duration(&mut self, duration: Duration)

Sets the starting duration of the timer, but does not change the remaining time on the timer. See reset to reset the remaining time to the starting duration.

pub fn remaining(&self) -> Duration

Returns the time currently remaining on the timer.

pub fn set_remaining(&mut self, remaining: Duration)

Sets the time currently remaining on the timer. Sets/unsets that the timer has finished as appropriate.

pub fn elapsed(&self) -> Duration

Returns the time that has elapsed on the timer.

pub fn set_elapsed(&mut self, elapsed: Duration)

Sets the time currently elapsed on the timer. Sets/unsets that the timer has finished as appropriate.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a copy 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() -> Timer

Returns the “default value” for a type.

impl PartialEq for Timer

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

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

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

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

impl Eq for Timer

impl StructuralEq for Timer

impl StructuralPartialEq for Timer