Enum rich_sdl2_rust::event::game_controller::button::Button

#[non_exhaustive]
pub enum Button {
    LeftFour(FourButton),
    RightFour(FourButton),
    Back,
    Guide,
    Start,
    LeftStick,
    RightStick,
    LeftShoulder,
    RightShoulder,
}

A button on a game controller except the trigger buttons. Trigger buttons are covered by super::axis::Axis.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

LeftFour(FourButton)

Four buttons on the left.

RightFour(FourButton)

Four buttons on the right.

Back

A back button on the center.

Guide

A meta button on the center.

Start

A start button on the center.

LeftStick

A stick push button on the left.

RightStick

A stick push button on the right.

LeftShoulder

A sub trigger button on the left.

RightShoulder

A sub trigger button on the right.

Implementations

impl Button

pub fn to_mapping_string(self) -> Option<String>

Returns the mapping string if exists.

Trait Implementations

impl Clone for Button

fn clone(&self) -> Button

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Button

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

Formats the value using the given formatter.

impl Display for Button

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

Formats the value using the given formatter.

impl FromStr for Button

type Err = SdlError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Button

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 Button

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Button

fn partial_cmp(&self, other: &Button) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Button

impl Eq for Button

impl StructuralPartialEq for Button