Struct ButtonWatchGenerated 

pub struct ButtonWatchGenerated { /* private fields */ }

Available on target_os=none only.

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 fn new( pin: impl Into<Peri<'static, PIN_13>>, pressed_to: PressedTo, spawner: Spawner, ) -> Result<&'static Self>

Creates a new button monitor and spawns its background task.

Parameters

• 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.

pub fn from_button( button: Button<'static>, spawner: Spawner, ) -> Result<&'static Self>

A device abstraction for buttons that uses a background task to monitor presses.

This is useful for converting a Button returned from WifiAuto::connect() into a ButtonWatch for background monitoring.

Parameters

• button: An existing button (e.g., from WifiAuto::connect())
• spawner: Task spawner for background operations

Errors

Returns an error if the background task cannot be spawned.

Trait Implementations

impl Deref for ButtonWatchGenerated

type Target = ButtonWatch

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.