Skip to main content

KeyCode

Enum KeyCode 

Source
pub enum KeyCode {
Show 25 variants Backspace, Enter, Left, Right, Up, Down, Home, End, PageUp, PageDown, Tab, BackTab, Delete, Insert, F(u8), Char(char), Esc, CapsLock, ScrollLock, NumLock, PrintScreen, Pause, Menu, KeypadBegin, Null,
}
Expand description

A key code representing a keyboard key.

Variants§

§

Backspace

Backspace key.

§

Enter

Enter/Return 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 (backtab).

§

Delete

Delete key.

§

Insert

Insert key.

§

F(u8)

Function key (F1-F24).

§

Char(char)

A character key (includes space).

§

Esc

Escape key.

§

CapsLock

Caps Lock key (rarely reported).

§

ScrollLock

Scroll Lock key.

§

NumLock

Num Lock key.

§

PrintScreen

Print Screen key.

§

Pause

Pause key.

§

Menu

Menu key.

§

KeypadBegin

Keypad Begin (numpad 5 without numlock).

§

Null

Null (Ctrl+Space or Ctrl+@).

Implementations§

Source§

impl KeyCode

Source

pub fn is_function_key(&self) -> bool

Check if this is a function key.

Source

pub fn is_char(&self) -> bool

Check if this is a character key.

Source

pub fn is_navigation(&self) -> bool

Check if this is a navigation key (arrows, home, end, page up/down).

Source

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

Get the character if this is a character key.

Trait Implementations§

Source§

impl Clone for KeyCode

Source§

fn clone(&self) -> KeyCode

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KeyCode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<KeyCode> for KeyEvent

Source§

fn from(code: KeyCode) -> Self

Converts to this type from the input type.
Source§

impl Hash for KeyCode

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for KeyCode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for KeyCode

Source§

impl Eq for KeyCode

Source§

impl StructuralPartialEq for KeyCode

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.