Struct KeyEvent 

pub struct KeyEvent {
    pub key: Key,
    pub modifiers: KeyModifiers,
}

A keyboard event

Fields

key: Key

The key that was pressed

modifiers: KeyModifiers

Key modifiers (Ctrl, Alt, Shift)

Implementations

impl KeyEvent

pub fn new(key: Key, modifiers: KeyModifiers) -> KeyEvent

Create a new key event

pub fn is_char(&self) -> bool

Check if this is a simple character key press

pub fn char(&self) -> Option<char>

Get the character if this is a character key

pub fn is(&self, key: Key) -> bool

Check if this key event matches a specific key

Example

if key_event.is(Key::Enter) {
    // Handle enter key
}

pub fn is_with_modifiers(&self, key: Key, modifiers: KeyModifiers) -> bool

Check if this key event matches a specific key with modifiers

Example

if key_event.is_with_modifiers(Key::Char('s'), KeyModifiers::CONTROL) {
    // Handle Ctrl+S
}

pub fn is_ctrl(&self) -> bool

Check if control key is held

pub fn is_alt(&self) -> bool

Check if alt key is held

pub fn is_shift(&self) -> bool

Check if shift key is held

pub fn is_super(&self) -> bool

Check if super/meta key is held

pub fn is_navigation(&self) -> bool

Check if this is a navigation key (arrows, home, end, page up/down)

pub fn is_function_key(&self) -> bool

Check if this is a function key (F1-F24)

pub fn is_media_key(&self) -> bool

Check if this is a media control key

pub fn has_modifiers(&self) -> bool

Check if this key event has any modifiers

pub fn no_modifiers(&self) -> bool

Check if this key event has no modifiers

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

fn from(event: KeyEvent) -> KeyEvent

Converts to this type from the input type.

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