Struct Timer

pub struct Timer {
    pub offset: Duration,
    pub period: Duration,
    /* private fields */
}

A timer is conceptually a logical action that may re-schedule itself periodically.

For periodic timers, a reaction is synthesized which reschedules the timer.

Fields

offset: Duration

Minimal duration after the start of the program after which the timer starts to trigger.

period: Duration

Period between events emitted by this timer. A period of zero means that the timer will trigger exactly once after the specified offset.

Implementations

impl Timer

pub fn is_periodic(&self) -> bool

Whether the timer should repeat itself. A period of zero means that the timer will trigger exactly once after the specified offset.

Trait Implementations

impl ReactionTrigger<()> for Timer

fn is_present(&self, now: &EventTag, _start: &Instant) -> bool

Returns whether the trigger is present, given that the current logical time is the parameter.

fn get_value(&self, now: &EventTag, start: &Instant) -> Option<()>

Copies the value out, if it is present. Whether a value is present is not in general the same thing as whether this trigger Self::is_present. See crate::ReactionCtx::get.

fn use_value_ref<O>( &self, now: &EventTag, start: &Instant, action: impl FnOnce(Option<&()>) -> O, ) -> O

Execute an action using the current value of this trigger. The closure is called even if the value is absent (with a None argument).