Struct Input 

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

Backend-agnostic key input type.

When crossterm, termion, termwiz features are enabled, converting respective key input types into this Input type is defined.

use ratatui_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 ratatui_textarea::{TextArea, Input, Key};

let mut textarea = TextArea::default();

// Input Ctrl+A
textarea.input(Input {
    key: Key::Char('a'),
    ctrl: true,
    alt: false,
    shift: 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.

shift: bool

Shift modifier key. true means Shift key was pressed.

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate of the value.

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() -> Input

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Input

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Input

impl From<Event> for Input

Available on crate feature crossterm only.

fn from(event: Event) -> Self

Convert ratatui_crossterm::crossterm::event::Event into Input.

impl From<Event> for Input

Available on crate feature termion only.

fn from(event: Event) -> Self

Convert ratatui_termion::termion::event::Event into Input.

impl From<InputEvent> for Input

Available on crate feature termwiz only.

fn from(input: InputEvent) -> Self

Convert ratatui_termwiz::termwiz::input::InputEvent into Input.

impl From<Key> for Input

Available on crate feature termion only.

fn from(key: KeyEvent) -> Self

Convert ratatui_termion::termion::event::Key into Input.

termion does not provide a way to get Shift key’s state. Instead termion passes key inputs as-is. For example, when ‘Shift + A’ is pressed with US keyboard, termion passes ratatui_termion::termion::event::Key::Char('A'). We cannot know how the ‘A’ character was input.

So the shift field of the returned Input instance is always false except for combinations with arrow keys. For example, ratatui_termion::termion::event::Key::Char('A') is converted to Input { key: Key::Char('A'), shift: false, .. }.

impl From<KeyEvent> for Input

Available on crate feature crossterm only.

fn from(key: KeyEvent) -> Self

Convert ratatui_crossterm::crossterm::event::KeyEvent into Input.

impl From<KeyEvent> for Input

Available on crate feature termwiz only.

fn from(key: KeyEvent) -> Self

Convert ratatui_termwiz::termwiz::input::KeyEvent into Input.

impl From<MouseEvent> for Input

Available on crate feature crossterm only.

fn from(mouse: MouseEvent) -> Self

Convert ratatui_crossterm::crossterm::event::MouseEvent into Input.

impl From<MouseEvent> for Input

Available on crate feature termion only.

fn from(mouse: MouseEvent) -> Self

Convert ratatui_termion::termion::event::MouseEvent into Input.

impl From<MouseEvent> for Input

Available on crate feature termwiz only.

fn from(mouse: MouseEvent) -> Self

Convert ratatui_termwiz::termwiz::input::MouseEvent into Input.

impl From<PixelMouseEvent> for Input

Available on crate feature termwiz only.

fn from(mouse: PixelMouseEvent) -> Self

Convert ratatui_termwiz::termwiz::input::PixelMouseEvent into Input.

impl Hash for Input

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 Input

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

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 Input