Enum EventButton 

#[repr(u8)]
pub enum EventButton {
    Left,
    Right,
    Middle,
    X1,
    X2,
    X3,
    X4,
    X5,
    Other(u8),
}

Available on crate feature event only.

🎫 🎮 ∈ A normalized pressable pointer/mouse button.

---

^{📍 ui/event::EventButton}

^{📦 size_of::<EventButton>() == 2 bytes / 16 bits ⚗️Option<T> 🟰 T}

---

Left, Middle, and Right represent the three primary conventional buttons. X1..X5 represent additional auxiliary button slots when a backend can report them.

These variants name normalized button slots, not guaranteed user actions. For example, X1 is often used as “back”, X2 as “forward”, and on Pointer Events a pen eraser may be reported through an auxiliary slot.

Variants

Left

🌱 Left mouse button.

Right

Right mouse button.

Middle

Middle mouse button (usually the scroll wheel button).

X1

The first auxiliary mouse button, commonly “back”.

X2

The second auxiliary mouse button, commonly “forward”.

X3

The third auxiliary mouse button.

X4

The fourth auxiliary mouse button.

X5

The fifth auxiliary mouse button.

Other(u8)

Additional buttons (e.g., side buttons on advanced mice).

Implementations

impl EventButton

pub const fn new(number: u8) -> Option<Self>

Returns some button as long as it’s not 0.

pub const fn from_one_bit_mask(mask: EventButtons) -> Option<EventButton>

Returns the button represented by the mask, if exactly one button is set.

pub const fn to_mask(self) -> EventButtons

Returns this button as a held-button mask, if it has a normalized role.

impl EventButton

pub const fn from_web(js_button: u8) -> Option<Self>

Available on crate feature web only.

Converts a DOM-compatible button value into a normalized button slot.

This preserves the reported button slot. It does not assign contextual roles such as “back”, “forward”, “barrel”, or “eraser”.

pub const fn to_web(self) -> u8

Available on crate feature web only.

Converts a normalized button slot into a DOM-compatible button value.

Trait Implementations

impl Clone for EventButton

fn clone(&self) -> EventButton

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstInit for EventButton

const INIT: Self = Self::Left

Returns the compile-time “initial value” for a type.

impl Copy for EventButton

impl Debug for EventButton

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

Formats the value using the given formatter.

impl Default for EventButton

fn default() -> EventButton

Returns the “default value” for a type.

impl Eq for EventButton

impl Hash for EventButton

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EventButton

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EventButton