ratatui_widgets::events

Enum Key

Source 
pub enum Key {

Show 18 variants    Char(char),
    Backspace,
    Delete,
    Insert,
    Enter,
    Left,
    Right,
    Up,
    Esc,
    Down,
    Home,
    End,
    PageUp,
    PageDown,
    Tab,
    BackTab,
    F(u8),
    Null,

}
👎Deprecated: Use tui-framework-experiment instead

Variants§

§

Char(char)

👎Deprecated: Use tui-framework-experiment instead
§

Backspace

👎Deprecated: Use tui-framework-experiment instead
§

Delete

👎Deprecated: Use tui-framework-experiment instead
§

Insert

👎Deprecated: Use tui-framework-experiment instead
§

Enter

👎Deprecated: Use tui-framework-experiment instead
§

Left

👎Deprecated: Use tui-framework-experiment instead
§

Right

👎Deprecated: Use tui-framework-experiment instead
§

Up

👎Deprecated: Use tui-framework-experiment instead
§

Esc

👎Deprecated: Use tui-framework-experiment instead
§

Down

👎Deprecated: Use tui-framework-experiment instead
§

Home

👎Deprecated: Use tui-framework-experiment instead
§

End

👎Deprecated: Use tui-framework-experiment instead
§

PageUp

👎Deprecated: Use tui-framework-experiment instead
§

PageDown

👎Deprecated: Use tui-framework-experiment instead
§

Tab

👎Deprecated: Use tui-framework-experiment instead
§

BackTab

👎Deprecated: Use tui-framework-experiment instead
§

F(u8)

👎Deprecated: Use tui-framework-experiment instead
§

Null

👎Deprecated: Use tui-framework-experiment instead

Implementations§

Source§

impl Key

Source

pub const fn is_char(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Char otherwise false

Source

pub const fn is_backspace(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Backspace otherwise false

Source

pub const fn is_delete(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Delete otherwise false

Source

pub const fn is_insert(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Insert otherwise false

Source

pub const fn is_enter(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Enter otherwise false

Source

pub const fn is_left(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Left otherwise false

Source

pub const fn is_right(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Right otherwise false

Source

pub const fn is_up(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Up otherwise false

Source

pub const fn is_esc(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Esc otherwise false

Source

pub const fn is_down(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Down otherwise false

Source

pub const fn is_home(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Home otherwise false

Source

pub const fn is_end(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::End otherwise false

Source

pub const fn is_page_up(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::PageUp otherwise false

Source

pub const fn is_page_down(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::PageDown otherwise false

Source

pub const fn is_tab(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Tab otherwise false

Source

pub const fn is_back_tab(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::BackTab otherwise false

Source

pub const fn is_f(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::F otherwise false

Source

pub const fn is_null(&self) -> bool

👎Deprecated: Use tui-framework-experiment instead

Returns true if the enum is Key::Null otherwise false

Trait Implementations§

Source§

impl Clone for Key

Source§

fn clone(&self) -> Key

Returns a duplicate 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 Key

Source§

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

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

impl Hash for Key

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Key

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl TryFrom<KeyCode> for Key

Source§

type Error = ConversionError

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

fn try_from(key_code: CrosstermKeyCode) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl Eq for Key

Source§

impl StructuralPartialEq for Key

Auto Trait Implementations§

§

impl Freeze for Key

§

impl RefUnwindSafe for Key

§

impl Send for Key

§

impl Sync for Key

§

impl Unpin for Key

§

impl UnwindSafe for Key

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

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>,

Source§

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>,

Source§

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.