Enum KeyCode 

pub enum KeyCode {
    Char(char),
    Enter,
    Esc,
    Tab,
    Backspace,
    Delete,
    Insert,
    Up,
    Down,
    Left,
    Right,
    Home,
    End,
    PageUp,
    PageDown,
    F(u8),
}

Represents a keyboard key.

This enum covers all keys commonly used in TUI applications, including:

• Alphanumeric characters
• Special keys (Enter, Tab, Esc, etc.)
• Navigation keys (arrows, Home, End, etc.)
• Function keys (F1-F12)

Example

use ratatui_testlib::events::KeyCode;

let letter = KeyCode::Char('a');
let enter = KeyCode::Enter;
let arrow = KeyCode::Up;
let function = KeyCode::F(1); // F1

Variants

Char(char)

A character key (letters, numbers, symbols).

Enter

Enter key (newline).

Esc

Escape key.

Tab

Tab key.

Backspace

Backspace key.

Delete

Delete key.

Insert

Insert key.

Up

Up arrow key.

Down

Down arrow key.

Left

Left arrow key.

Right

Right arrow key.

Home

Home key.

End

End key.

PageUp

Page Up key.

PageDown

Page Down key.

F(u8)

Function keys F1-F12.

Example

use ratatui_testlib::events::KeyCode;

let f1 = KeyCode::F(1);
let f12 = KeyCode::F(12);

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

Formats the value using the given formatter.

impl Hash for KeyCode

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

impl Eq for KeyCode

impl StructuralPartialEq for KeyCode