Struct KeyEvent 

pub struct KeyEvent {
    pub key_code: KeyCode,
    pub text: String,
    pub modifiers: Modifiers,
    pub event_type: KeyEventType,
}

A keyboard input event.

Contains information about which key was pressed/released, the text it produces (if any), and modifier state.

Fields

key_code: KeyCode

The physical key that was pressed.

text: String

The text produced by this key press (may be empty for non-character keys). This accounts for keyboard layout and modifiers (e.g., Shift+A = “A”).

modifiers: Modifiers

Current state of modifier keys.

event_type: KeyEventType

Type of event (down or up).

Implementations

impl KeyEvent

pub fn new( key_code: KeyCode, text: impl Into<String>, modifiers: Modifiers, event_type: KeyEventType, ) -> KeyEvent

Creates a new key event.

pub fn key_down(key_code: KeyCode, text: impl Into<String>) -> KeyEvent

Creates a key down event with the given key code and text.

pub fn key_down_with_modifiers( key_code: KeyCode, text: impl Into<String>, modifiers: Modifiers, ) -> KeyEvent

Creates a key down event with modifiers.

pub fn is_key_down(&self) -> bool

Returns true if this is a key down event.

pub fn is_key_up(&self) -> bool

Returns true if this is a key up event.

pub fn has_text(&self) -> bool

Returns true if this key produces printable text.

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<(), Error>

Formats the value using the given formatter.

impl Display for KeyEvent

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

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

impl StructuralPartialEq for KeyEvent