Struct KeyEvent 

pub struct KeyEvent {
    pub code: KeyCode,
    pub modifiers: Modifiers,
    pub kind: KeyEventKind,
}

A keyboard event.

Fields

code: KeyCode

The key code that was pressed.

modifiers: Modifiers

Modifier keys held during the event.

kind: KeyEventKind

The type of key event (press, repeat, or release).

Implementations

impl KeyEvent

pub const fn new(code: KeyCode) -> Self

Create a new key event with default modifiers and Press kind.

pub const fn with_modifiers(self, modifiers: Modifiers) -> Self

Create a key event with modifiers.

pub const fn with_kind(self, kind: KeyEventKind) -> Self

Create a key event with a specific kind.

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

Check if this is a specific character key.

pub const fn ctrl(&self) -> bool

Check if Ctrl modifier is held.

pub const fn alt(&self) -> bool

Check if Alt modifier is held.

pub const fn shift(&self) -> bool

Check if Shift modifier is held.

pub const fn super_key(&self) -> bool

Check if Super/Meta/Cmd modifier is held.

Trait Implementations

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

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

Formats the value using the given formatter.

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 Copy for KeyEvent

impl Eq for KeyEvent

impl StructuralPartialEq for KeyEvent