KeyCode

Enum KeyCode

#[repr(C)]pub enum KeyCode {
Show 27 variants    Backspace,
    Enter,
    Left,
    Right,
    Up,
    Down,
    Home,
    End,
    PageUp,
    PageDown,
    Tab,
    BackTab,
    Delete,
    Insert,
    F(u8),
    Char(char),
    Null,
    Esc,
    CapsLock,
    ScrollLock,
    NumLock,
    PrintScreen,
    Pause,
    Menu,
    KeypadBegin,
    Media(MediaKeyCode),
    Modifier(ModifierKeyCode),
}

Expand description

Represents a key.

Variants§

Backspace

Backspace key.

Enter

Enter key.

Left

Left arrow key.

Right

Right arrow key.

Up

Up arrow key.

Down

Down arrow key.

Home

Home key.

End

End key.

PageUp

Page up key.

PageDown

Page down key.

Tab

Tab key.

BackTab

Shift + Tab key.

Delete

Delete key.

Insert

Insert key.

F(u8)

F key.

KeyCode::F(1) represents F1 key, etc.

Char(char)

A character.

KeyCode::Char('c') represents c character, etc.

Null

Null.

Esc

Escape key.

CapsLock

Caps Lock key.

Note: this key can only be read if [KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES] has been enabled with [PushKeyboardEnhancementFlags].

ScrollLock

Scroll Lock key.

Note: this key can only be read if [KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES] has been enabled with [PushKeyboardEnhancementFlags].

NumLock

Num Lock key.

Note: this key can only be read if [KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES] has been enabled with [PushKeyboardEnhancementFlags].

PrintScreen

Print Screen key.

Note: this key can only be read if [KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES] has been enabled with [PushKeyboardEnhancementFlags].

Pause

Pause key.

Note: this key can only be read if [KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES] has been enabled with [PushKeyboardEnhancementFlags].

Menu key.

Note: this key can only be read if [KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES] has been enabled with [PushKeyboardEnhancementFlags].

KeypadBegin

The “Begin” key (often mapped to the 5 key when Num Lock is turned on).

Note: this key can only be read if [KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES] has been enabled with [PushKeyboardEnhancementFlags].

Media(MediaKeyCode)

A media key.

Note: these keys can only be read if [KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES] has been enabled with [PushKeyboardEnhancementFlags].

Modifier(ModifierKeyCode)

A modifier key.

Note: these keys can only be read if both [KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES] and [KeyboardEnhancementFlags::REPORT_ALL_KEYS_AS_ESCAPE_CODES] have been enabled with [PushKeyboardEnhancementFlags].

Auto Trait Implementations§

impl Freeze for KeyCode

impl RefUnwindSafe for KeyCode

impl Send for KeyCode

impl Sync for KeyCode

impl Unpin for KeyCode

impl UnwindSafe for KeyCode

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.