Enum State

pub enum State<I> {
    Down(I),
    Pressed(I),
    Up(I),
    Held(I),
    Released,
    Unknown,
}

Represents current button state.

State machine diagram:

 Down => Pressed | Released
 Pressed => Held => Up
 Up => Released | Down
 Held => Released
 Released => Down
 Unknown => Down | Released

Variants

Down(I)

The button has been just pressed, so it is in down position.

Pressed(I)

Debounced press.

Up(I)

The button has been just released, so it is in up position.

Held(I)

The button is being held.

Released

Fully released state, idle.

Unknown

Initial state.

Implementations

impl<I: PartialEq> State<I>

pub fn is_down(&self) -> bool

Returns true if the state is Down.

pub fn is_pressed(&self) -> bool

Returns true if the state is Pressed.

pub fn is_up(&self) -> bool

Returns true if the state is Up.

pub fn is_held(&self) -> bool

Returns true if the state is Held.

pub fn is_released(&self) -> bool

Returns true if the state is Released.

pub fn is_unknown(&self) -> bool

Returns true if the state is Unknown.

Trait Implementations

impl<I: Clone> Clone for State<I>

fn clone(&self) -> State<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for State<I>

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

Formats the value using the given formatter.

impl<I: PartialEq> PartialEq for State<I>

fn eq(&self, other: &State<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<I: Copy> Copy for State<I>

impl<I: Eq> Eq for State<I>

impl<I> StructuralPartialEq for State<I>