Struct avr_oxide::devices::button::Button

pub struct Button<'b, S>
where
    S: EventSink,
{ /* private fields */ }

Encapsulation of a Button attached to a standard GPIO pin. Generates Oxide events on button events (press/release.)

Implementations

impl<'b, S> Button<'b, S>

where S: 'static + EventSink,

pub fn on_click(&self, bf: Box<dyn FnMut(PinIdentity, ButtonState) + 'b>)

Have the Oxide supervisor execute the given closure every time an event is generated by this device.

pub fn pullup(self, enable: bool) -> Self

Enable or disable the internal pullup on this pin

pub fn is_pressed(&self) -> bool

True if and only if this button is currently pressed

pub fn state(&self) -> ButtonState

Return the current state of this button.

pub fn wait_for_change(&self) -> ButtonState

Block until the state of this button changes. The new state is returned.

Trait Implementations

impl<S> EventSource for Button<'_, S>

where S: EventSink,

fn listen(&'static self)

fn process_event(&self, evt: OxideEvent)

impl<'b, S> UsesPin for Button<'b, S>

where S: 'static + EventSink,

fn using<OP: Into<OwnOrBorrow<'static, dyn Pin>>>(pin: OP) -> Self

Create an instance of this device that uses the given instance of a pin (by ownership or reference.)

fn with_pin(pin: &'static dyn Pin) -> Self

where Self: Sized,

Convenience method to create an instance of this device with a given static reference to a pin (avoids a certain amount of type hinting boilerplate for the caller.)

fn static_using<OP: Into<OwnOrBorrow<'static, dyn Pin>>>( pin: OP ) -> &'static mut Self

where Self: Sized,

Create an instance of this device that uses the given instance of a pin, and return a static reference good for the lifetime of the program.

fn static_with_pin(pin: &'static dyn Pin) -> &'static mut Self

where Self: Sized,

Create an instance of this device that uses the given reference to a pin, and return a static reference good for the lifetime of the program.

impl<S> Send for Button<'_, S>

where S: EventSink,

impl<S> Sync for Button<'_, S>

where S: EventSink,