Enum KeyCode

pub enum KeyCode {
    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),
}

Represents a key.

Variants

Backspace

Backspace key (Delete on macOS, Backspace on other platforms).

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. (Fn+Delete on macOS, Delete on other platforms)

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

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.

Implementations

impl KeyCode

pub fn is_function_key(&self, n: u8) -> bool

Returns true if the key code is the given function key.

Examples

assert!(KeyCode::F(1).is_function_key(1));
assert!(!KeyCode::F(1).is_function_key(2));

pub fn is_char(&self, c: char) -> bool

Returns true if the key code is the given character.

Examples

assert!(KeyCode::Char('a').is_char('a'));
assert!(!KeyCode::Char('a').is_char('b'));
assert!(!KeyCode::F(1).is_char('a'));

pub fn as_char(&self) -> Option<char>

Returns the character if the key code is a character key.

Returns None if the key code is not a character key.

Examples

assert_eq!(KeyCode::Char('a').as_char(), Some('a'));
assert_eq!(KeyCode::F(1).as_char(), None);

pub fn is_media_key(&self, media: MediaKeyCode) -> bool

Returns true if the key code is the given media key.

Note: this method requires KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES to be enabled with PushKeyboardEnhancementFlags.

Examples

assert!(KeyCode::Media(MediaKeyCode::Play).is_media_key(MediaKeyCode::Play));
assert!(!KeyCode::Media(MediaKeyCode::Play).is_media_key(MediaKeyCode::Pause));

pub fn is_modifier(&self, modifier: ModifierKeyCode) -> bool

Returns true if the key code is the given modifier key.

Note: this method requires both KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES and KeyboardEnhancementFlags::REPORT_ALL_KEYS_AS_ESCAPE_CODES to be enabled with PushKeyboardEnhancementFlags.

Examples

assert!(KeyCode::Modifier(ModifierKeyCode::LeftShift).is_modifier(ModifierKeyCode::LeftShift));
assert!(!KeyCode::Modifier(ModifierKeyCode::LeftShift).is_modifier(ModifierKeyCode::RightShift));

Trait Implementations

impl Clone for KeyCode

fn clone(&self) -> KeyCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyCode

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

Formats the value using the given formatter.

impl Display for KeyCode

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

Formats the KeyCode using the given formatter.

Platform-specific Notes

On macOS, the Backspace key is displayed as “Delete”, the Delete key is displayed as “Fwd Del”, and the Enter key is displayed as “Return”. See https://support.apple.com/guide/applestyleguide/welcome/1.0/web.

On other platforms, the Backspace key is displayed as “Backspace”, the Delete key is displayed as “Del”, and the Enter key is displayed as “Enter”.

impl Hash for KeyCode

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 PartialEq for KeyCode

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

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

impl Eq for KeyCode

impl StructuralPartialEq for KeyCode