Skip to main content

Debouncer

Struct Debouncer 

Source
pub struct Debouncer {
    stable: bool,
    candidate: bool,
    count: u8,
}
Expand description

Software debouncer state.

Holds the last stable level and a running counter that increments while the raw input matches the candidate new level and resets when it does not. Once the counter reaches DEBOUNCE_STABLE_SAMPLES the candidate becomes the new stable level.

Fields§

§stable: bool

Currently-accepted stable level.

§candidate: bool

Candidate level being observed.

§count: u8

Consecutive samples matching candidate.

Implementations§

Source§

impl Debouncer

Source

pub const fn new(initial: bool) -> Self

Build a fresh debouncer assuming the initial level is initial.

Source

pub fn sample(&mut self, level: bool) -> Option<bool>

Feed one new sample.

Returns Some(level) when the stable level just changed as a result of this sample, None otherwise. The caller can use this as a trigger to issue a press/release event.

Source

pub const fn stable(&self) -> bool

Current stable level (without consuming a sample).

Useful for diagnostics: a task can query the current stable state without committing to a sampling cycle. The touch_task logs this at startup so the developer can confirm the resting state of the button line via defmt RTT or USB CDC trace.

Trait Implementations§

Source§

impl Clone for Debouncer

Source§

fn clone(&self) -> Debouncer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Debouncer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Debouncer

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Debouncer

Source§

impl Eq for Debouncer

Source§

impl StructuralPartialEq for Debouncer

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.