Enum KeyLocation

#[repr(u8)]
pub enum KeyLocation {
    Standard = 0,
    Left = 1,
    Right = 2,
    Numpad = 3,
}

The location of the key on the keyboard.

Certain physical keys on the keyboard can have the same value, but are in different locations. For instance, the Shift key can be on the left or right side of the keyboard, or the number keys can be above the letters or on the numpad. This enum allows the user to differentiate them.

Variants

Standard = 0

The key is in its “normal” location on the keyboard.

For instance, the “1” key above the “Q” key on a QWERTY keyboard will use this location. This invariant is also returned when the location of the key cannot be identified.

Left = 1

The key is on the left side of the keyboard.

For instance, the left Shift key below the Caps Lock key on a QWERTY keyboard will use this location.

Right = 2

The key is on the right side of the keyboard.

For instance, the right Shift key below the Enter key on a QWERTY keyboard will use this location.

Numpad = 3

The key is on the numpad.

For instance, the “1” key on the numpad will use this location.

Implementations

impl KeyLocation

pub fn name(self) -> &'static str

Gets the variant name.

Trait Implementations

impl Clone for KeyLocation

fn clone(&self) -> KeyLocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyLocation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyLocation

fn deserialize<__D>( __deserializer: __D, ) -> Result<KeyLocation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for KeyLocation

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 PartialEq for KeyLocation

fn eq(&self, other: &KeyLocation) -> 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 Serialize for KeyLocation

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for KeyLocation

impl Eq for KeyLocation

impl StructuralPartialEq for KeyLocation