Struct Timer

pub struct Timer { /* private fields */ }

Used for single or repeated timed events, uses fractional seconds

Update

When using Timer::update or Timer::update_secs, note that

• for timers created with Timer::new_once those methods will continue to return true until Timer::reset is called
• other timers will only return true once per duration then automatically reset

Usage

let mut  timer = Timer::new_with_delay(1.0, 1.0);
loop {
   if timer.update_secs(delta) {
        break;
   }
}

Implementations

impl Timer

pub fn new_with_delay(delay: f64, duration: f64) -> Timer

Create a timer that will wait delay seconds then trigger every duration seconds

Usage

Timer::new_with_delay(2.0, 0.1) will wait 2s then trigger every 0.1s

pub fn new(duration: f64) -> Timer

Create a timer that will trigger every duration seconds

Usage

Timer::new(0.1) will trigger immediately and then every 0.1s

pub fn new_once(after: f64) -> Timer

Create a timer with the duration of after seconds that only triggers once Use Timer::reset to reset back to 0 and start counting again

impl Timer

pub fn update(&mut self, timing: &Timing) -> bool

Update timer, returns true if triggered

pub fn update_secs(&mut self, delta: f64) -> bool

Update timer, returns true if triggered delta is fractional seconds passed since last call

pub fn reset(&mut self)

Set remaining to reset value (the number passed into the constructor) One time loops can trigger again after calling this

pub fn has_triggered(&self) -> bool

If the timer has reached 0, this will always be false for looping timers (unless reset is <= 0.0)

pub fn trigger(&mut self)

Set remaining time to 0, triggering the timer

pub fn delay(&mut self, seconds: f64)

Add seconds to remaining time, this can be higher than the duration

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Timer

fn deserialize<__D>( __deserializer: __D, ) -> Result<Timer, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Timer