Struct zng_app::timer::TimerHandle

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

Represents a on_interval handler.

Drop all clones of this handler to stop the timer, or call perm to drop the handler without cancelling the timer.

Implementations

impl TimerHandle

pub fn dummy() -> TimerHandle

Create a handle to nothing, the handle is always in the stopped state.

Note that Option<TimerHandle> takes up the same space as TimerHandle and avoids an allocation.

pub fn perm(self)

Drops the handle but does not drop the handler closure.

The handler closure will be dropped when the app exits or if it is stopped from the inside or using another handle.

pub fn is_permanent(&self) -> bool

If perm was called in another handle.

If true the closure will keep being called until the app exits or the timer is stopped from the inside or using another handle.

pub fn stop(self)

Drops the handle and forces the handler to drop.

The handler will no longer be called and will drop in the next app update.

pub fn is_stopped(&self) -> bool

If the timer was stopped. The timer can be stopped from the inside, from another handle calling stop or from the app shutting down.

pub fn interval(&self) -> Duration

The timer interval. Enabled handlers are called 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 elapsed time, or the start time if the timer has not elapsed 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 pause(&self)

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

pub fn is_playing(&self) -> bool

If the timer is ticking.

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.

Note that this method does not wake the app, so if this is called from outside the app the timer will only start ticking in next app update.

pub fn count(&self) -> usize

Count incremented by one every time the timer elapses.

pub fn set_count(&self, count: usize)

Resets the count.

pub fn downgrade(&self) -> WeakTimerHandle

Create a weak handle to the timer.

Trait Implementations

impl Clone for TimerHandle

fn clone(&self) -> TimerHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimerHandle

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

Formats the value using the given formatter.

impl Hash for TimerHandle

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TimerHandle

fn eq(&self, other: &TimerHandle) -> 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 Eq for TimerHandle

impl StructuralPartialEq for TimerHandle