Struct Timer 

pub struct Timer { /* private fields */ }

A countdown toward a duration. Tick it with the frame delta and read Timer::just_finished for the cycle it completes, Timer::fraction for progress to drive a bar or a fade, or Timer::remaining for a clock.

Implementations

impl Timer

pub fn new(duration: f32, mode: TimerMode) -> Timer

A timer of duration seconds with the given mode.

pub fn once(duration: f32) -> Timer

A one-shot timer of duration seconds.

pub fn repeating(duration: f32) -> Timer

A repeating timer that elapses every duration seconds.

pub fn tick(&mut self, delta: f32) -> &mut Timer

Advances the timer by delta seconds, returning it for chaining. A repeating timer wraps and counts every cycle the delta crossed; a finished one-shot timer ignores further ticks until reset; a paused timer ignores the delta entirely.

pub fn finished(&self) -> bool

Whether the timer reached its duration. For a repeating timer this is true only on a tick that completed a cycle, matching Timer::just_finished.

pub fn just_finished(&self) -> bool

Whether the most recent tick completed at least one cycle.

pub fn times_finished_this_tick(&self) -> u32

How many full cycles the most recent tick completed. Always 0 or 1 for a one-shot timer; for a repeating timer a long frame can complete several.

pub fn elapsed(&self) -> f32

Seconds elapsed in the current cycle.

pub fn remaining(&self) -> f32

Seconds left in the current cycle.

pub fn duration(&self) -> f32

The configured duration in seconds.

pub fn fraction(&self) -> f32

Progress through the current cycle from 0 at the start to 1 at the end.

pub fn fraction_remaining(&self) -> f32

Progress remaining in the current cycle, from 1 at the start to 0 at the end.

pub fn mode(&self) -> TimerMode

This timer’s mode.

pub fn paused(&self) -> bool

Whether the timer is paused.

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

Sets the duration, keeping elapsed time. Negative values clamp to zero.

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

Sets the elapsed time into the current cycle.

pub fn set_mode(&mut self, mode: TimerMode)

Switches between one-shot and repeating.

pub fn set_paused(&mut self, paused: bool)

Pauses or resumes ticking.

pub fn pause(&mut self)

Pauses ticking.

pub fn unpause(&mut self)

Resumes ticking.

pub fn reset(&mut self)

Clears elapsed time and the finished state, leaving duration and mode.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Timer

impl Debug for Timer

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

Formats the value using the given formatter.

impl Default for Timer

fn default() -> Timer

Returns the “default value” for a type.

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

Equality operator ==.

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

Inequality operator !=.

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