Struct Buttons

pub struct Buttons { /* private fields */ }

Button mask

Implementations

impl Buttons

pub const Primary: Buttons

Primary button

Usually left for right hand.

pub const Secondary: Buttons

Secondary button

Usually right for right hand.

pub const Tertiary: Buttons

Tertiary button

Usually middle.

pub const fn bits(&self) -> u8

Returns the underlying bits of the bitmask.

pub const fn all_bits() -> Buttons

Returns a bitmask that contains all values.

This will include bits that do not have any flags. Use ::all_flags() if you only want to use flags.

pub const fn all_flags() -> Buttons

Returns a bitmask that contains all flags.

pub const fn is_all_bits(&self) -> bool

Returns true if the bitmask contains all values.

This will check for bits == !0, use .is_all_flags() if you only want to check for all flags

pub const fn is_all_flags(&self) -> bool

Returns true if the bitmask contains all flags.

This will fail if any unused bit is set, consider using .truncate() first.

pub const fn all() -> Buttons

👎Deprecated: Please use the ::all_bits() constructor

Returns a bitmask that contains all values.

This will include bits that do not have any flags. Use ::all_flags() if you only want to use flags.

pub const fn is_all(&self) -> bool

👎Deprecated: Please use the .is_all_bits() method

Returns true if the bitmask contains all values.

This will check for bits == !0, use .is_all_flags() if you only want to check for all flags

pub const fn full() -> Buttons

👎Deprecated: Please use the ::all_flags() constructor

Returns a bitmask that contains all flags.

pub const fn is_full(&self) -> bool

👎Deprecated: Please use the .is_all_flags() method

Returns true if the bitmask contains all flags.

This will fail if any unused bit is set, consider using .truncate() first.

pub const fn none() -> Buttons

Returns a bitmask that does not contain any values.

pub const fn is_none(&self) -> bool

Returns true if the bitmask does not contain any values.

pub const fn truncate(&self) -> Buttons

Returns a bitmask that only has bits corresponding to flags

pub const fn intersects(&self, other: Buttons) -> bool

Returns true if self intersects with any value in other, or if other does not contain any values.

This is equivalent to (self & other) != 0 || other == 0.

pub const fn contains(&self, other: Buttons) -> bool

Returns true if self contains all values of other.

This is equivalent to (self & other) == other.

pub const fn not(self) -> Buttons

Returns the bitwise NOT of the bitmask.

pub const fn and(self, other: Buttons) -> Buttons

Returns the bitwise AND of the bitmask.

pub const fn or(self, other: Buttons) -> Buttons

Returns the bitwise OR of the bitmask.

pub const fn xor(self, other: Buttons) -> Buttons

Returns the bitwise XOR of the bitmask.

impl Buttons

pub fn safe_from(raw: u8) -> Option<Buttons>

Converts from raw value safely

Trait Implementations

impl AsMut<[u8]> for Buttons

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Buttons

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Binary for Buttons

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

Formats the value using the given formatter.

impl BitAnd for Buttons

type Output = Buttons

The resulting type after applying the & operator.

fn bitand(self, rhs: Buttons) -> <Buttons as BitAnd>::Output

Performs the & operation.

impl BitAndAssign for Buttons

fn bitand_assign(&mut self, rhs: Buttons)

Performs the &= operation.

impl BitOr for Buttons

type Output = Buttons

The resulting type after applying the | operator.

fn bitor(self, rhs: Buttons) -> <Buttons as BitOr>::Output

Performs the | operation.

impl BitOrAssign for Buttons

fn bitor_assign(&mut self, rhs: Buttons)

Performs the |= operation.

impl BitXor for Buttons

type Output = Buttons

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Buttons) -> <Buttons as BitXor>::Output

Performs the ^ operation.

impl BitXorAssign for Buttons

fn bitxor_assign(&mut self, rhs: Buttons)

Performs the ^= operation.

impl Clone for Buttons

fn clone(&self) -> Buttons

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Buttons

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

Formats the value using the given formatter.

impl Default for Buttons

fn default() -> Buttons

Returns the “default value” for a type.

impl From<Button> for Buttons

fn from(key: Button) -> Buttons

Converts to this type from the input type.

impl From<Buttons> for Button

fn from(mods: Buttons) -> Button

Converts to this type from the input type.

impl From<u8> for Buttons

fn from(val: u8) -> Buttons

Converts to this type from the input type.

impl Hash for Buttons

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

where __H: Hasher,

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 LowerHex for Buttons

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

Formats the value using the given formatter.

impl Not for Buttons

type Output = Buttons

The resulting type after applying the ! operator.

fn not(self) -> <Buttons as Not>::Output

Performs the unary ! operation.

impl Octal for Buttons

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

Formats the value using the given formatter.

impl Ord for Buttons

fn cmp(&self, other: &Buttons) -> 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<u8> for Buttons

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for Buttons

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Buttons

fn partial_cmp(&self, other: &Buttons) -> 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 UpperHex for Buttons

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

Formats the value using the given formatter.

impl Copy for Buttons

impl Eq for Buttons

impl StructuralPartialEq for Buttons