Struct ButtonChord 

pub struct ButtonChord { /* private fields */ }

What a controller binding is: one Button, or two pressed together (a button chord, ticket 1034), written "South+East" in keymap files and saved bindings. The two are kept in Button::ALL order, so "East+South" is the same chord as "South+East" (and is shown as the latter). How a chord fires is the input’s business (shuyi_ui::input::state).

Implementations

impl ButtonChord

pub const fn single(button: Button) -> Self

One button on its own.

pub fn pair(a: Button, b: Button) -> Option<Self>

a and b pressed together, in either order; None if they are the same button.

pub fn first(self) -> Button

The button, or a chord’s first button in Button::ALL order.

pub fn single_button(self) -> Option<Button>

The button, if this is one button on its own.

pub fn buttons(self) -> Option<(Button, Button)>

The two buttons, in Button::ALL order, if this is a chord.

pub fn partner(self, button: Button) -> Option<Button>

The other button of a chord that has button, if this is one.

pub fn parse(s: &str) -> Result<Self, String>

Parses "South" or "South+East" (either order).

Trait Implementations

impl Clone for ButtonChord

fn clone(&self) -> ButtonChord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ButtonChord

impl Debug for ButtonChord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ButtonChord

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ButtonChord

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

Formats the value using the given formatter.

impl Eq for ButtonChord

impl From<Button> for ButtonChord

fn from(button: Button) -> Self

Converts to this type from the input type.

impl FromStr for ButtonChord

type Err = String

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 ButtonChord

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 Ord for ButtonChord

fn cmp(&self, other: &ButtonChord) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ButtonChord

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Button> for ButtonChord

A binding is a button when it is that button on its own.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ButtonChord

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for ButtonChord

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 ButtonChord