Enum Event 

pub enum Event<D: TimeDuration, I: TimeInstant<Duration = D>> {
    Press {
        at: I,
    },
    Release {
        duration: D,
        click_follows: bool,
    },
    Click {
        count: u8,
    },
    Hold {
        clicks_before: u8,
        level: u8,
    },
}

A button event produced by the state machine.

Variants

Press

The button was pressed. Fires immediately on press edge. at is the timestamp of the press, identical to what crate::ButtHead::press_instant returns during the pressed state.

Fields

at: I

Release

The button was released. duration is the total time it was held. click_follows is true when a Event::Click will follow (the release ends a click gesture), and false when it ends a hold gesture.

Fields

duration: D

click_follows: bool

Click

A complete click gesture (press + release, no hold). count starts at 1. Fires once after click_timeout expires with no further press. A double-click produces a single Click { count: 2 }.

Fields

count: u8

Hold

The button is being held. Fires repeatedly at a configured interval. clicks_before is the number of clicks that preceded this hold (0 = plain hold, 1 = click+hold, 2 = double-click+hold, …). level increments on each repeat (0 = first hold event, 1 = second, …).

Fields

clicks_before: u8

level: u8

Trait Implementations

impl<D: Clone + TimeDuration, I: Clone + TimeInstant<Duration = D>> Clone for Event<D, I>

fn clone(&self) -> Event<D, I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug + TimeDuration, I: Debug + TimeInstant<Duration = D>> Debug for Event<D, I>

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

Formats the value using the given formatter.

impl<D: PartialEq + TimeDuration, I: PartialEq + TimeInstant<Duration = D>> PartialEq for Event<D, I>

fn eq(&self, other: &Event<D, I>) -> 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<D: Copy + TimeDuration, I: Copy + TimeInstant<Duration = D>> Copy for Event<D, I>

impl<D: Eq + TimeDuration, I: Eq + TimeInstant<Duration = D>> Eq for Event<D, I>

impl<D: TimeDuration, I: TimeInstant<Duration = D>> StructuralPartialEq for Event<D, I>