Enum Key 

pub enum Key {
    Up,
    Down,
    Left,
    Right,
    Tab,
    BackTab,
    Enter,
    Space,
    Esc,
    Backspace,
    Delete,
    Insert,
    Home,
    End,
    PageUp,
    PageDown,
    Function(u8),
    Ctrl(char),
    Alt(char),
    CtrlAlt(char),
    ShiftEnter,
    WordLeft,
    WordRight,
    WordDelete,
    Paste,
    PasteRaw,
    Char(char),
}

Decoded keyboard input, terminal-agnostic.

Variants

Up

Arrow up: widget-local cursor until the top edge, then focus ring.

Down

Arrow down: widget-local cursor until the bottom edge, then ring.

Left

Arrow left: chips/enums/number fields consume; else focus ring.

Right

Arrow right: chips/enums/number fields consume; else focus ring.

Tab

Next focusable widget (always escapes the current widget).

BackTab

Previous focusable widget.

Enter

Activate / choose / newline (editor) / press (button).

Space

Toggle (checkbox/multi) or activate; literal space in text entry.

Esc

Close popup, then clear filter, then cancel the whole dialog.

Backspace

Delete before the cursor in text entry.

Delete

Delete under the cursor in text entry.

Insert

Insert at the cursor.

Home

Jump to line/list start.

End

Jump to line/list end.

PageUp

Scroll one viewport up.

PageDown

Scroll one viewport down.

Function(u8)

Function key, numbered from F1 through F12.

Ctrl(char)

Ctrl-chord with a letter, normalized to lowercase. Text widgets implement the readline set (a e k u w b f d); others ignore.

Alt(char)

Alt-chord with a letter, normalized to lowercase, for chords without a canonical cross-terminal meaning (e.g. pi binds alt+y yank-pop). Encoding variants of one physical intent (alt+f/alt+b word motion, alt+d word delete, ESC-CR newline) normalize to their semantic keys instead and never reach this variant.

CtrlAlt(char)

Ctrl+Alt chord, normalized to lowercase. Used by pi’s backward character-jump binding and available to embedders for other chords.

ShiftEnter

Shift+Enter: literal newline in multiline text entry.

WordLeft

Ctrl/Alt+Left: previous word boundary.

WordRight

Ctrl/Alt+Right: next word boundary.

WordDelete

Alt+D / Alt+Delete: delete forward through the next word end.

Paste

Ctrl+V: host-driven clipboard paste, preferring images (see the runtime’s clipboard fallback).

PasteRaw

Ctrl+Shift+V: host-driven clipboard paste of text only, inserted verbatim (crate::Component::paste_raw) — no image or file-URL interpretation, no drop classification, no large-paste collapse.

Char(char)

Printable input: text entry, type-to-search (/), shortcuts.

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

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

Equality operator ==.

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

Inequality operator !=.

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