Struct stakker::MaxTimerKey

pub struct MaxTimerKey { /* private fields */ }

Timer key for a Max timer

Used by the timer_max! macro and the timer_max_* methods in Core. It can be used to delete a timer or change its expiry time. It is plain Copy data, 8 bytes long. Note that the key should only be used on this same Stakker instance. If it is used on another then it might cause a panic.

A “max” timer sets a timer at the first-provided timeout time, then just records the largest of the timeout values provided until that original timer expires, at which point it sets a new timer. So this naturally absorbs a lot of changes without having to delete any timers. A typical use might be to take some action in a gap in activity, for example to do an expensive background check in a gap in the user’s typing into a UI field. To implement this, the timer expiry time might be set to ‘now’ + 300ms by each keypress, for example:

fn handle_keypress(&mut self, cx: CX![], ...) {
    :::
    timer_max!(&mut self.timer,
               cx.now() + Duration::from_millis(300),
               [cx], check_focus_field());
}

Trait Implementations

impl Clone for MaxTimerKey

fn clone(&self) -> MaxTimerKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaxTimerKey

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

Formats the value using the given formatter.

impl Default for MaxTimerKey

fn default() -> MaxTimerKey

Returns the “default value” for a type.

impl PartialEq<MaxTimerKey> for MaxTimerKey

fn eq(&self, other: &MaxTimerKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for MaxTimerKey

impl Eq for MaxTimerKey

impl StructuralEq for MaxTimerKey

impl StructuralPartialEq for MaxTimerKey