Struct KeyboardEvent 

pub struct KeyboardEvent {
    pub key_code: KeyCode,
    pub modifiers: KeyModifiers,
    pub kind: KeyEventKind,
}

A keyboard input event.

Fields

key_code: KeyCode

modifiers: KeyModifiers

kind: KeyEventKind

Implementations

impl KeyboardEvent

pub fn from_crossterm(event: KeyEvent) -> KeyboardEvent

pub fn is_key_down(&self) -> bool

pub fn is_key_up(&self) -> bool

pub fn is_char(&self, c: char) -> bool

pub fn is_code(&self, code: KeyCode) -> bool

pub fn has_modifier(&self, modifier: KeyModifiers) -> bool

pub fn is_enter(&self) -> bool

pub fn is_escape(&self) -> bool

pub fn is_tab(&self) -> bool

pub fn is_backtab(&self) -> bool

pub fn is_backspace(&self) -> bool

pub fn is_delete(&self) -> bool

pub fn is_space(&self) -> bool

Trait Implementations

impl Clone for KeyboardEvent

fn clone(&self) -> KeyboardEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardEvent

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

Formats the value using the given formatter.

impl Display for KeyboardEvent

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

Formats the value using the given formatter.

impl PartialEq for KeyboardEvent

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

impl StructuralPartialEq for KeyboardEvent