async_button

Struct Button

Source 
pub struct Button<P> { /* private fields */ }
Expand description

A generic button that asynchronously detects ButtonEvents.

Implementations§

Source§

impl<P> Button<P>
where P: Wait + InputPin,

Source

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

Creates a new button with the provided config.

Source

pub async fn update(&mut self) -> ButtonEvent

Updates the button and returns the detected event.

Awaiting this blocks execution of the task until a ButtonEvent is detected so it should not be called from tasks where blocking for long periods of time is not desireable.

Trait Implementations§

Source§

impl<P: Clone> Clone for Button<P>

Source§

fn clone(&self) -> Button<P>

Returns a copy 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<P: Debug> Debug for Button<P>

Source§

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

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

impl<P: Copy> Copy for Button<P>

Auto Trait Implementations§

§

impl<P> Freeze for Button<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for Button<P>
where P: RefUnwindSafe,

§

impl<P> Send for Button<P>
where P: Send,

§

impl<P> Sync for Button<P>
where P: Sync,

§

impl<P> Unpin for Button<P>
where P: Unpin,

§

impl<P> UnwindSafe for Button<P>
where P: UnwindSafe,

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.