Enum PhysicalKey

pub enum PhysicalKey {
    Code(KeyCode),
    Unidentified(NativeKeyCode),
}

Represents the location of a physical key.

This type is a superset of KeyCode, including an Unidentified variant.

Variants

Code(KeyCode)

A known key code

Unidentified(NativeKeyCode)

This variant is used when the key cannot be translated to a KeyCode

The native keycode is provided (if available) so you’re able to more reliably match key-press and key-release events by hashing the PhysicalKey. It is also possible to use this for keybinds for non-standard keys, but such keybinds are tied to a given platform.

Trait Implementations

impl Clone for PhysicalKey

fn clone(&self) -> PhysicalKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PhysicalKey

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

Formats the value using the given formatter.

impl From<KeyCode> for PhysicalKey

fn from(code: KeyCode) -> PhysicalKey

Converts to this type from the input type.

impl From<NativeKeyCode> for PhysicalKey

fn from(code: NativeKeyCode) -> PhysicalKey

Converts to this type from the input type.

impl Hash for PhysicalKey

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 PhysicalKey

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

fn eq(&self, rhs: &KeyCode) -> 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<NativeKeyCode> for PhysicalKey

fn eq(&self, rhs: &NativeKeyCode) -> 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<PhysicalKey> for KeyCode

fn eq(&self, rhs: &PhysicalKey) -> 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<PhysicalKey> for NativeKeyCode

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

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

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

fn to_scancode(self) -> Option<u32>

The raw value of the platform-specific physical key identifier.

fn from_scancode(scancode: u32) -> PhysicalKey

Constructs a PhysicalKey from a platform-specific physical key identifier.

impl Copy for PhysicalKey

impl Eq for PhysicalKey

impl StructuralPartialEq for PhysicalKey