Struct keycode::KeyModifiers

pub struct KeyModifiers { /* fields omitted */ }

Bitmask for key modifiers based on the USB HID standard

See the stardard here:

https://www.usb.org/sites/default/files/documents/hid1_11.pdf

Go to page 56, "8.3 Report Format for Array Items"

Methods

impl KeyModifiers

pub const CONTROL_LEFT: KeyModifiers

Control left key bitmask

pub const SHIFT_LEFT: KeyModifiers

Shift left key bitmask

pub const ALT_LEFT: KeyModifiers

Alt left key bitmask

pub const META_LEFT: KeyModifiers

Meta left key bitmask

pub const CONTROL_RIGHT: KeyModifiers

Control right key bitmask

pub const SHIFT_RIGHT: KeyModifiers

Shift right key bitmask

pub const ALT_RIGHT: KeyModifiers

Alt right key bitmask

pub const META_RIGHT: KeyModifiers

Meta right key bitmask

pub const fn empty() -> KeyModifiers

Returns an empty set of flags

pub const fn all() -> KeyModifiers

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<KeyModifiers>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> KeyModifiers

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: KeyModifiers)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: KeyModifiers)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: KeyModifiers)

Toggles the specified flags in-place.

pub fn set(&mut self, other: KeyModifiers, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl PartialEq<KeyModifiers> for KeyModifiers

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

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

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

This method tests for !=.

impl Eq for KeyModifiers

impl Ord for KeyModifiers

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<KeyModifiers> for KeyModifiers

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

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

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

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

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

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

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

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

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

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

impl Hash for KeyModifiers

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, 

Feeds a slice of this type into the given [Hasher].

impl Sub<KeyModifiers> for KeyModifiers

type Output = KeyModifiers

The resulting type after applying the - operator.

fn sub(self, other: KeyModifiers) -> KeyModifiers

Returns the set difference of the two sets of flags.

impl SubAssign<KeyModifiers> for KeyModifiers

fn sub_assign(&mut self, other: KeyModifiers)

Disables all flags enabled in the set.

impl Not for KeyModifiers

type Output = KeyModifiers

The resulting type after applying the ! operator.

fn not(self) -> KeyModifiers

Returns the complement of this set of flags.

impl BitAnd<KeyModifiers> for KeyModifiers

type Output = KeyModifiers

The resulting type after applying the & operator.

fn bitand(self, other: KeyModifiers) -> KeyModifiers

Returns the intersection between the two sets of flags.

impl BitOr<KeyModifiers> for KeyModifiers

type Output = KeyModifiers

The resulting type after applying the | operator.

fn bitor(self, other: KeyModifiers) -> KeyModifiers

Returns the union of the two sets of flags.

impl BitXor<KeyModifiers> for KeyModifiers

type Output = KeyModifiers

The resulting type after applying the ^ operator.

fn bitxor(self, other: KeyModifiers) -> KeyModifiers

Returns the left flags, but with all the right flags toggled.

impl BitAndAssign<KeyModifiers> for KeyModifiers

fn bitand_assign(&mut self, other: KeyModifiers)

Disables all flags disabled in the set.

impl BitOrAssign<KeyModifiers> for KeyModifiers

fn bitor_assign(&mut self, other: KeyModifiers)

Adds the set of flags.

impl BitXorAssign<KeyModifiers> for KeyModifiers

fn bitxor_assign(&mut self, other: KeyModifiers)

Toggles the set of flags.

impl Debug for KeyModifiers

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

Formats the value using the given formatter.

impl FromIterator<KeyModifiers> for KeyModifiers

fn from_iter<T: IntoIterator<Item = KeyModifiers>>(iterator: T) -> KeyModifiers

Creates a value from an iterator.

impl Octal for KeyModifiers

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

Formats the value using the given formatter.

impl Binary for KeyModifiers

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

Formats the value using the given formatter.

impl LowerHex for KeyModifiers

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

Formats the value using the given formatter.

impl UpperHex for KeyModifiers

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

Formats the value using the given formatter.

impl Copy for KeyModifiers

impl Extend<KeyModifiers> for KeyModifiers

fn extend<T: IntoIterator<Item = KeyModifiers>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl Clone for KeyModifiers

fn clone(&self) -> KeyModifiers

Returns a copy of the value.

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

Performs copy-assignment from source.