Struct sprocket_engine::Timer

pub struct Timer { /* fields omitted */ }

A general purpose timer for measuring execution time or checking if a certain time has passed Timer can be stopped and this will stop time from being counted A timer can also have a target sets and can be queried if that target has been passed

Implementations

impl Timer

pub fn new() -> Self

Starts a new timer without a target

pub fn with_target(duration: Duration) -> Self

Creates a new timer which is going to be signaled after specified duration

pub fn set_target(&mut self, target: Option<Duration>)

Sets a target for timer Replaces an old one Does not reset a timer. Target can be immediately passed Signaled state reflects the new target

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

Returns the current target for the timer

pub fn duration(&self) -> Duration

Returns the current duration of the timer If called on a stopped timer, it return that when it was stopped

pub fn stop(&mut self) -> Duration

Stops the timer and returns the duration The duration can be retrieved again with Timer::duration()

pub fn reset(&mut self)

Restarts a stopped timer Makes the timer be signaled again after target time from now

pub fn running(&self) -> bool

Returns true if the timer is currently running

pub fn stopped(&self) -> bool

Returns true if the timer is currently stopped The opposite of Timer::running()

pub fn signaled(&self) -> bool

Returns true if the timer has passed the target

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

Returns the time to the target if any Returns None if target is None, target has passed, or timer is stopped

pub fn remaining_ms(&self) -> Option<usize>

Returns the time in whole milliseconds to the target if any Returns None if target is None, target has passed, or timer is stopped

pub fn remaining_us(&self) -> Option<usize>

Returns the time in whole microseconds to the target if any Returns None if target is None, target has passed, or timer is stopped

pub fn remaining_f32(&self) -> Option<f32>

Returns the time in fractional seconds to the target if any Returns None if target is None, target has passed, or timer is stopped