Enum KeyInput 

pub enum KeyInput {
    Char(char),
    Up,
    Down,
    Left,
    Right,
    Home,
    End,
    PageUp,
    PageDown,
    Enter,
    Backspace,
    Delete,
    Escape,
    Tab,
    F(u8),
    Ctrl(char),
    Alt(char),
    Shift(char),
    CtrlUp,
    CtrlDown,
    CtrlLeft,
    CtrlRight,
    CtrlHome,
    CtrlEnd,
    AltUp,
    AltDown,
    AltEnter,
    ShiftUp,
    ShiftDown,
}

Framework-agnostic key input representation.

Consumers map their framework’s events to this type. For example:

• crossterm: KeyEvent → KeyInput
• winit: KeyEvent → KeyInput
• egui: Key → KeyInput

Keyboard Layout Considerations

When using Shift(char), be aware that keyboard layouts vary:

• US: Shift+'n' produces 'N'
• German: Shift+'7' produces '/'

For cross-layout compatibility, prefer:

• Function keys (F1-F12) for important actions
• Ctrl/Alt modifiers with navigation keys
• Unshifted character keys for common actions

Variants

Char(char)

A character key was pressed

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

Enter

Enter/Return key

Backspace

Backspace key

Delete

Delete key

Escape

Escape key

Tab

Tab key

F(u8)

Function key (F1-F12)

Ctrl(char)

Ctrl + character

Alt(char)

Alt + character

Shift(char)

Shift + character (for uppercase letters)

CtrlUp

Ctrl + Up arrow

CtrlDown

Ctrl + Down arrow

CtrlLeft

Ctrl + Left arrow

CtrlRight

Ctrl + Right arrow

CtrlHome

Ctrl + Home

CtrlEnd

Ctrl + End

AltUp

Alt + Up arrow

AltDown

Alt + Down arrow

AltEnter

Alt + Enter

ShiftUp

Shift + Up arrow

ShiftDown

Shift + Down arrow

Implementations

impl KeyInput

pub fn is_char(&self) -> bool

Check if this is a character key (including modified characters)

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

Get the character if this is a character key

pub fn has_ctrl(&self) -> bool

Check if this key has Ctrl modifier

pub fn has_alt(&self) -> bool

Check if this key has Alt modifier

pub fn has_shift(&self) -> bool

Check if this key has Shift modifier

Trait Implementations

impl Clone for KeyInput

fn clone(&self) -> KeyInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyInput

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

Formats the value using the given formatter.

impl Hash for KeyInput

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 KeyInput

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

impl StructuralPartialEq for KeyInput