Struct Button

pub struct Button<P, I, D = Duration> {
    pub pin: P,
    /* private fields */
}

Generic button abstraction.

The crate is designed to provide a finished (released) state by the accessor methods. However, it is also possible to get the raw state using the corresponding methods.

Fields

pin: P

An inner pin.

Implementations

impl<P, I, D> Button<P, I, D>

where P: PinWrapper, I: InstantProvider<D> + PartialEq, D: Clone + Ord,

pub const fn new(pin: P, config: ButtonConfig<D>) -> Self

Creates a new Button.

pub fn clicks(&self) -> usize

Returns the number of clicks that happened before the last release. Returns 0 if clicks are still being counted or a new streak has started.

pub fn holds(&self) -> usize

Returns the number of holds (how many times the button was held) that happened before the last release. Returns 0 if clicks or holds are still being counted or a new streak has started.

pub fn reset(&mut self)

Resets clicks amount and held time after release.

Example:

In this example, reset method makes “Clicked!” print once per click.

let mut button = Button::new(pin, ButtonConfig::default());

loop {
    button.tick();
     
    if button.is_clicked() {
        println!("Clicked!");
    }

    button.reset();
}

pub fn is_clicked(&self) -> bool

Returns true if the button was pressed once before release.

pub fn is_double_clicked(&self) -> bool

Returns true if the button was pressed twice before release.

pub fn is_triple_clicked(&self) -> bool

Returns true if the button was pressed three times before release.

pub fn held_time(&self) -> Option<D>

Returns holding duration before the last release. Returns None if the button is still being held, not released or was not held at all.

pub fn current_holding_time(&self) -> Option<D>

Returns current holding duration. Returns None if the button is not being held.

pub const fn raw_state(&self) -> &State<I>

Returns current button state.

pub const fn raw_clicks(&self) -> usize

Returns current amount of clicks, ignoring release timeout.

pub const fn raw_holds(&self) -> usize

Returns current amount of holds (how many times the button was held), ignoring release timeout.

pub fn tick(&mut self)

Updates button state. Call as frequently as you can, ideally in a loop in separate thread or interrupt.

Trait Implementations

impl<P: Clone, I: Clone, D: Clone> Clone for Button<P, I, D>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Debug, I: Debug, D: Debug> Debug for Button<P, I, D>

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

Formats the value using the given formatter.