Struct ButtonPress 

pub struct ButtonPress {
    pub pin: u32,
    pub label: Option<String>,
    pub kind: String,
    pub action: Option<String>,
    pub timestamp_ms: u64,
}

One decoded front-panel press.

pin is the board GPIO line (BCM on a Raspberry Pi, the Linux GPIO number elsewhere); label is the front-panel button (B1..B4, the key the button mapping uses), which stays the same across boards, so a subscriber that means “the first panel button” matches on the label. action is the host’s live mapping for that (button, kind) pair and is None for an unmapped button — a subscriber sees the press either way and decides for itself whether an unmapped button means anything.

A board with a rotary encoder delivers it through the same event: one detent is a short press labelled ENC_CW or ENC_CCW (pin is the encoder’s A line), and its push switch is a short/long press labelled ENC_SW.

Fields

pin: u32

Board GPIO line of the button.

label: Option<String>

Front-panel button label (B1..B4, BX<pin> for an extra button, ENC_CW / ENC_CCW / ENC_SW for the rotary encoder); None from a host that predates the field.

kind: String

"short" or "long", decoded by the host on the release edge.

action: Option<String>

Resolved action name from the live mapping; None when unmapped.

timestamp_ms: u64

Release-edge timestamp, monotonic milliseconds since the reader started.

Implementations

impl ButtonPress

pub fn is_long(&self) -> bool

True when this is a long press.

A helper rather than an enum on the wire: the host’s own bus carries the kind as a string, and re-typing it here would mean a third spelling to keep in step for no gain.

Trait Implementations

impl Clone for ButtonPress

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ButtonPress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ButtonPress

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ButtonPress

impl PartialEq for ButtonPress

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ButtonPress

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ButtonPress