Enum winit::keyboard::NativeKeyCode

pub enum NativeKeyCode {
    Unidentified,
    Android(u32),
    MacOS(u16),
    Windows(u16),
    Xkb(u32),
}

Contains the platform-native physical key identifier

The exact values vary from platform to platform (which is part of why this is a per-platform enum), but the values are primarily tied to the key’s physical location on the keyboard.

This enum is primarily used to store raw keycodes when Winit doesn’t map a given native physical key identifier to a meaningful KeyCode variant. In the presence of identifiers we haven’t mapped for you yet, this lets you use use KeyCode to:

• Correctly match key press and release events.
• On non-web platforms, support assigning keybinds to virtually any key through a UI.

Variants

Unidentified

Android(u32)

An Android “scancode”.

MacOS(u16)

A macOS “scancode”.

Windows(u16)

A Windows “scancode”.

Xkb(u32)

An XKB “keycode”.

Trait Implementations

impl Clone for NativeKeyCode

fn clone(&self) -> NativeKeyCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NativeKeyCode

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

Formats the value using the given formatter.

impl From<NativeKeyCode> for NativeKey

fn from(code: NativeKeyCode) -> Self

Converts to this type from the input type.

impl From<NativeKeyCode> for PhysicalKey

fn from(code: NativeKeyCode) -> Self

Converts to this type from the input type.

impl Hash for NativeKeyCode

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for NativeKeyCode

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

Restrict a value to a certain interval.

impl PartialEq<NativeKey> for NativeKeyCode

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

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<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 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 NativeKeyCode

fn eq(&self, other: &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 PartialOrd for NativeKeyCode

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

impl Eq for NativeKeyCode

impl StructuralPartialEq for NativeKeyCode