Struct ButtonWatchGenerated 

pub struct ButtonWatchGenerated;

Sample struct type generated by the button_watch! macro, showing all methods.

This page serves as the definitive reference for what a generated button watch type provides. For first-time readers, start with the examples in the button_watch! macro documentation, then return here for a complete list of available methods.

Implementations

impl ButtonWatchGenerated

pub async fn new( button_pin: impl Sized, pressed_to: PressedTo, spawner: Spawner, ) -> Result<&'static mut Self>

Creates a new button monitor and spawns its background task.

Parameters

• button_pin: GPIO pin for the button
• pressed_to: How the button is wired (PressedTo::Ground or PressedTo::Voltage)
• spawner: Task spawner for background operations

Errors

Returns an error if the background task cannot be spawned.

Example

See the button_watch! macro for usage.

Trait Implementations

impl Button for ButtonWatchGenerated

fn is_pressed(&self) -> bool

Returns whether the button is currently pressed.

async fn wait_for_press(&mut self)

Waits for the next press (button goes down, debounced). Does not wait for release.

async fn wait_for_press_duration(&mut self) -> PressDuration

Waits for the next press and returns whether it was short or long (debounced).