Struct tui_textarea::Input

pub struct Input {
    pub key: Key,
    pub ctrl: bool,
    pub alt: bool,
}

Backend-agnostic key input type.

When crossterm and/or termion features are enabled, converting their key input types into this Input type is defined.

use tui_textarea::{TextArea, Input, Key};
use crossterm::event::{Event, read};

let event = read().unwrap();

// `Input::from` can convert backend-native event into `Input`
let input = Input::from(event.clone());
// or `Into::into`
let input: Input = event.clone().into();
// Conversion from `KeyEvent` value is also available
if let Event::Key(key) = event {
    let input = Input::from(key);
}

Creating Input instance directly can cause backend-agnostic input as follows.

use tui_textarea::{TextArea, Input, Key};

let mut textarea = TextArea::default();

// Input Ctrl+A
textarea.input(Input {
    key: Key::Char('a'),
    ctrl: true,
    alt: false,
});

Fields

key: Key

Typed key.

ctrl: bool

Ctrl modifier key. true means Ctrl key was pressed.

alt: bool

Alt modifier key. true means Alt key was pressed.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Input

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 Input

fn clone(&self) -> Input

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Input

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

Formats the value using the given formatter.

impl Default for Input

fn default() -> Self

The default input is Key::Null without pressing any modifier keys, which means invalid input.

impl From<Event> for Input

fn from(event: CrosstermEvent) -> Self

Convert crossterm::event::Event to Input.

impl From<Event> for Input

fn from(event: TermionEvent) -> Self

Convert termion::event::Event to Input.

impl From<Key> for Input

fn from(key: TermionKey) -> Self

Convert termion::event::Key to Input.

impl From<KeyEvent> for Input

fn from(key: KeyEvent) -> Self

Convert crossterm::event::KeyEvent to Input.

impl From<MouseEvent> for Input

fn from(mouse: CrosstermMouseEvent) -> Self

Convert crossterm::event::MouseEvent to Input.

impl From<MouseEvent> for Input

fn from(mouse: TermionMouseEvent) -> Self

Convert termion::event::MouseEvent to Input.