Enum Key 

#[non_exhaustive]
pub enum Key {
    Char(char),
    F(u8),
    Backspace,
    Enter,
    Left,
    Right,
    Up,
    Down,
    Tab,
    Delete,
    Home,
    End,
    PageUp,
    PageDown,
    Esc,
    Copy,
    Cut,
    Paste,
    MouseScrollDown,
    MouseScrollUp,
    Null,
}

Backend-agnostic key input kind.

This type is marked as #[non_exhaustive] since more keys may be supported in the future.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Char(char)

Normal letter key input

F(u8)

F1, F2, F3, … keys

Backspace

Backspace key

Enter

Enter or return key

Left

Left arrow key

Right

Right arrow key

Up

Up arrow key

Down

Down arrow key

Tab

Tab key

Delete

Delete key

Home

Home key

End

End key

PageUp

Page up key

PageDown

Page down key

Esc

Escape key

Copy

Copy key. This key is supported by termwiz only

Cut

Cut key. This key is supported by termwiz only

Paste

Paste key. This key is supported by termwiz only

MouseScrollDown

Virtual key to scroll down by mouse

MouseScrollUp

Virtual key to scroll up by mouse

Null

An invalid key input (this key is always ignored by TextArea)

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

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

Formats the value using the given formatter.

impl Default for Key

fn default() -> Key

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Key

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Key

impl From<KeyCode> for Key

Available on crate feature crossterm only.

fn from(code: KeyCode) -> Self

Convert ratatui_crossterm::crossterm::event::KeyCode into Key.

impl From<KeyCode> for Key

Available on crate feature termwiz only.

fn from(key: KeyCode) -> Self

Convert ratatui_termwiz::termwiz::input::KeyCode into Key.

impl From<MouseButton> for Key

Available on crate feature termion only.

fn from(button: MouseButton) -> Self

Convert ratatui_termion::termion::event::MouseButton into Key.

impl From<MouseButtons> for Key

Available on crate feature termwiz only.

fn from(buttons: MouseButtons) -> Self

Convert ratatui_termwiz::termwiz::input::MouseButtons into Key.

impl From<MouseEventKind> for Key

Available on crate feature crossterm only.

fn from(kind: MouseEventKind) -> Self

Convert ratatui_crossterm::crossterm::event::MouseEventKind into Key.

impl Hash for Key

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

fn eq(&self, other: &Key) -> 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 Serialize for Key

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Key