Struct Timer 

pub struct Timer { /* private fields */ }

Explicitly ticked timer with pause, reset and exact duration accounting. A zero-duration timer completes once per non-paused tick, including a zero tick.

Implementations

impl Timer

pub fn new(duration: Duration, mode: TimerMode) -> Self

Creates an unpaused timer at zero elapsed time.

pub fn once(seconds: f32) -> Option<Self>

Creates a one-shot timer from finite non-negative seconds. Invalid or unrepresentable durations return None.

pub fn repeating(seconds: f32) -> Option<Self>

Creates a repeating timer from finite non-negative seconds.

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

Advances time and replaces this tick’s completion count. Paused ticks clear completion pulses while preserving elapsed time and the sticky finished state of one-shot timers.

pub fn tick_secs(&mut self, seconds: f32) -> &mut Self

Ticks using a script/frame delta in seconds. Invalid deltas are ignored and clear completion edges, so a bad frame cannot poison timer state.

pub fn duration(&self) -> Duration

Configured interval.

pub fn elapsed(&self) -> Duration

Elapsed part of the interval (clamped for one-shot, wrapped for repeating).

pub fn remaining(&self) -> Duration

Time remaining until the next completion. A finished one-shot returns zero.

pub fn fraction(&self) -> f32

Progress in [0, 1]; zero-duration timers return one after their first tick.

pub fn finished(&self) -> bool

Whether a one-shot is complete, or a repeating timer completed this tick.

pub fn just_finished(&self) -> bool

Whether the most recent tick crossed at least one interval.

pub fn times_finished(&self) -> u64

Number of crossed intervals in the last tick, saturating at u64::MAX.

pub fn mode(&self) -> TimerMode

Current repetition policy.

pub fn is_paused(&self) -> bool

Whether ticks are suspended.

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

Suspends or resumes the timer without resetting it.

pub fn reset(&mut self)

Clears elapsed/completion state while preserving duration, mode and pause.

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

Replaces the interval and resets progress, preserving mode and pause.

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

Replaces the repetition policy and resets progress.

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

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

Formats the value using the given formatter.