Enum ratatui_textarea::Key

#[non_exhaustive]
pub enum Key {
    Char(char),
    F(u8),
    Backspace,
    Enter,
    Left,
    Right,
    Up,
    Down,
    Tab,
    Delete,
    Home,
    End,
    PageUp,
    PageDown,
    Esc,
    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

Enter

Left

Right

Up

Down

Tab

Delete

Home

End

PageUp

PageDown

Esc

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<'arbitrary> Arbitrary<'arbitrary> for Key

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Copy for Key