Enum Key 

#[non_exhaustive]
pub enum Key {
    Enter,
    Space,
    Backspace,
    Escape,
    Tab,
    Up,
    Down,
    Left,
    Right,
    Home,
    End,
    Char(char),
    Interrupt,
    Unknown,
}

A single decoded keystroke from an interactive terminal.

Only the keys the prompt widgets act on are modelled; anything else decodes to Key::Unknown so callers can ignore it without a catch-all on a platform enum.

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.

Enter

Confirm the current answer (Enter / Return).

Space

Space bar — toggles the focused item in multi-select, or inserts a literal space in text entry.

Backspace

Delete the character before the cursor (Backspace).

Escape

Abandon the prompt (Escape).

Tab

Advance focus (Tab).

Up

Move focus up / to the previous item.

Down

Move focus down / to the next item.

Left

Move the text cursor left.

Right

Move the text cursor right.

Home

Jump to the first item / start of line.

End

Jump to the last item / end of line.

Char(char)

A printable character was typed.

Interrupt

A cancellation request (Ctrl+C / Ctrl+D).

Unknown

A key with no prompt-relevant meaning.

Implementations

impl Key

pub const fn is_interrupt(self) -> bool

Whether this key represents a cancellation request.

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

impl PartialEq for Key

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Key