Struct ratatui_textarea::Input

source ·
pub struct Input {
    pub key: Key,
    pub ctrl: bool,
    pub alt: bool,
}
Expand description

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 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,
});

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§

source§

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

source§

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

Generate an arbitrary value of Self from the given unstructured data. Read more
source§

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

Generate an arbitrary value of Self from the entirety of the given unstructured data. Read more
source§

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. Read more
source§

impl Clone for Input

source§

fn clone(&self) -> Input

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Input

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Input

source§

fn default() -> Self

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

source§

impl From<Event> for Input

source§

fn from(event: TermionEvent) -> Self

source§

impl From<Event> for Input

source§

impl From<Key> for Input

source§

fn from(key: TermionKey) -> Self

source§

impl From<KeyEvent> for Input

source§

impl From<MouseEvent> for Input

source§

impl From<MouseEvent> for Input

Auto Trait Implementations§

§

impl RefUnwindSafe for Input

§

impl Send for Input

§

impl Sync for Input

§

impl Unpin for Input

§

impl UnwindSafe for Input

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.