Struct UseTimer 

pub struct UseTimer {
    pub ticks: Signal<u64>,
    pub interval_ms: u32,
}

Reactive state for a repeating timer.

The handle carries the number of ticks that have fired and the period they fire at.

The tick count is a Signal<u64>: a render closure that reads it re-renders on every tick, and nothing else in the tree is disturbed.

The interval is owned by the framework and is cleared when the component unmounts, so a timer cannot outlive its owner.

Fields

ticks: Signal<u64>

How many times the timer has fired.

interval_ms: u32

The period in milliseconds.

Implementations

impl UseTimer

Inherent implementation of UseTimer.

pub fn current_ticks(&self) -> u64

Returns the tick count as a snapshot.

Returns

• u64 - How many times the timer has fired.

pub fn reset(&self)

Resets the tick count to zero.

impl UseTimer

pub fn get_ticks(&self) -> Signal<u64>

pub fn get_mut_ticks(&mut self) -> &mut Signal<u64>

pub fn set_ticks(&mut self, val: Signal<u64>) -> &mut Self

pub fn get_interval_ms(&self) -> u32

pub fn get_mut_interval_ms(&mut self) -> &mut u32

pub fn set_interval_ms(&mut self, val: u32) -> &mut Self

Trait Implementations

impl Clone for UseTimer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UseTimer

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

Formats the struct fields as a debug struct, skipping excluded fields.

Arguments

• &mut std::fmt::Formatter<'_> - The formatter to write the representation into.

Returns

• std::fmt::Result - Success or failure of the formatting operation.