Struct zng_app::timer::Timer

pub struct Timer(/* private fields */);

Represents a timer state in a TimerVar or interval handler.

This type uses interior mutability to communicate with the timer, the values provided by the methods can be changed anytime by the TimerVar owners without the variable updating.

Implementations

impl Timer

pub fn stop(&self)

Permanently stops the timer.

pub fn is_stopped(&self) -> bool

If the timer was stopped.

If true the timer var will not update again, this is permanent.

pub fn interval(&self) -> Duration

The timer interval. Enabled variables update every time this interval elapses.

pub fn set_interval(&self, new_interval: Duration)

Sets the interval.

Note that this method does not awake the app, so if this is called from outside the app thread it will only apply on the next app update.

pub fn timestamp(&self) -> DInstant

Last update time, or the start time if the timer has not updated yet.

pub fn deadline(&self) -> Deadline

The next deadline.

This is the timestamp plus the interval.

pub fn is_paused(&self) -> bool

If the timer is not ticking, but can be started again.

pub fn is_playing(&self) -> bool

If the timer is ticking.

pub fn pause(&self)

Disable the timer, this causes the timer to stop ticking until play is called.

pub fn play(&self, reset: bool)

Enable the timer, this causes it to start ticking again.

If reset is true the last timestamp is set to now.

pub fn count(&self) -> usize

Count incremented by one every time the timer elapses.

pub fn set_count(&self, count: usize)

Resets the count.

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

Formats the value using the given formatter.

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