Struct KeyEvent

pub struct KeyEvent {
    pub code: KeyCode,
    pub modifiers: KeyModifiers,
    pub kind: KeyEventKind,
    pub state: KeyEventState,
}

Available on crate features dep_crossterm and std only.

Represents a key event.

Fields

code: KeyCode

The key itself.

modifiers: KeyModifiers

Additional key modifiers.

kind: KeyEventKind

Kind of event.

Only set if:

• Unix: KeyboardEnhancementFlags::REPORT_EVENT_TYPES has been enabled with PushKeyboardEnhancementFlags.
• Windows: always

state: KeyEventState

Keyboard state.

Only set if KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES has been enabled with PushKeyboardEnhancementFlags.

Implementations

impl KeyEvent

pub const fn new(code: KeyCode, modifiers: KeyModifiers) -> KeyEvent

pub const fn new_with_kind( code: KeyCode, modifiers: KeyModifiers, kind: KeyEventKind, ) -> KeyEvent

pub const fn new_with_kind_and_state( code: KeyCode, modifiers: KeyModifiers, kind: KeyEventKind, state: KeyEventState, ) -> KeyEvent

Trait Implementations

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyEvent

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

Formats the value using the given formatter.

impl From<KeyCode> for KeyEvent

fn from(code: KeyCode) -> KeyEvent

Converts to this type from the input type.

impl Hash for KeyEvent

fn hash<H>(&self, hash_state: &mut H)

where H: Hasher,

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 KeyEvent

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

fn partial_cmp(&self, other: &KeyEvent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for KeyEvent

impl Eq for KeyEvent