Enum Location

pub enum Location {
    Standard = 0,
    Left = 1,
    Right = 2,
    Numpad = 3,
}

The location attribute contains an indication of the physical location of the key on the device.

Certain 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 differentiating them.

See also MDN’s documentation.

Variants

Standard = 0

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

The key activation MUST NOT be distinguished as the left or right version of the key, and (other than the NumLock key) did not originate from the numeric keypad (or did not originate with a virtual key corresponding to the numeric keypad).

This variant is the default, and is also used when the location of the key cannot be identified.

Example

The 1 key above the Q key on a QWERTY keyboard will use this location.

_{For image attribution, see the ATTRIBUTION.md file.}

Left = 1

The key activated originated from the left key location (when there is more than one possible location for this key).

Example

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

_{For image attribution, see the ATTRIBUTION.md file.}

Right = 2

The key activation originated from the right key location (when there is more than one possible location for this key).

Example

The right Shift key below the Enter key on a QWERTY keyboard will use this location.

_{For image attribution, see the ATTRIBUTION.md file.}

Numpad = 3

The key activation originated on the numeric keypad or with a virtual key corresponding to the numeric keypad (when there is more than one possible location for this key). Note that the NumLock key should always be encoded with a location of Location::Standard.

Example

The 1 key on the numpad will use this location.

_{For image attribution, see the ATTRIBUTION.md file.}

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl Default for Location

fn default() -> Location

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Location

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Location

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

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

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

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

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 Location

impl Eq for Location

impl StructuralPartialEq for Location