Enum winit::keyboard::NativeKey

pub enum NativeKey {
    Unidentified,
    Android(u32),
    MacOS(u16),
    Windows(u16),
    Xkb(u32),
    Web(SmolStr),
}

Contains the platform-native logical key identifier

Exactly what that means differs from platform to platform, but the values are to some degree tied to the currently active keyboard layout. The same key on the same keyboard may also report different values on different platforms, which is one of the reasons this is a per-platform enum.

This enum is primarily used to store raw keysym when Winit doesn’t map a given native logical key identifier to a meaningful Key variant. This lets you use Key, and let the user define keybinds which work in the presence of identifiers we haven’t mapped for you yet.

Variants

Unidentified

Android(u32)

An Android “keycode”, which is similar to a “virtual-key code” on Windows.

MacOS(u16)

A macOS “scancode”. There does not appear to be any direct analogue to either keysyms or “virtual-key” codes in macOS, so we report the scancode instead.

Windows(u16)

A Windows “virtual-key code”.

Xkb(u32)

An XKB “keysym”.

Web(SmolStr)

A “key value string”.

Trait Implementations

impl Clone for NativeKey

fn clone(&self) -> NativeKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NativeKey

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

Formats the value using the given formatter.

impl From<NativeKey> for Key

fn from(code: NativeKey) -> Self

Converts to this type from the input type.

impl From<NativeKeyCode> for NativeKey

fn from(code: NativeKeyCode) -> Self

Converts to this type from the input type.

impl Hash for NativeKey

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 NativeKey

fn cmp(&self, other: &NativeKey) -> 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<Str> PartialEq<Key<Str>> for NativeKey

fn eq(&self, rhs: &Key<Str>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Str> PartialEq<NativeKey> for Key<Str>

fn eq(&self, rhs: &NativeKey) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<NativeKey> for NativeKeyCode

fn eq(&self, rhs: &NativeKey) -> bool

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

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

This method 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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for NativeKey

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NativeKey

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

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

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

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

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

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

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

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

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

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

impl Eq for NativeKey

impl StructuralEq for NativeKey

impl StructuralPartialEq for NativeKey