Struct KeyEvent 

#[non_exhaustive]
pub struct KeyEvent<'a> {
    pub key: Key<'a>,
    pub text: Option<&'a str>,
    pub pressed: bool,
    pub repeat: bool,
    pub modifiers: Modifiers,
}

A key event.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: Key<'a>

The key, after the keyboard layout.

text: Option<&'a str>

The text the key types, if any: what an editor inserts.

pressed: bool

Down (true) or up.

repeat: bool

Down again because the key is held.

modifiers: Modifiers

Modifier keys held.

Implementations

impl<'a> KeyEvent<'a>

pub fn down(key: Key<'a>) -> Self

key going down, typing nothing, without modifiers.

pub fn up(key: Key<'a>) -> Self

key going up.

pub fn with_text(self, text: &'a str) -> Self

The event typing text.

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

The event with modifiers held.

pub fn repeated(self) -> Self

The event repeated because the key is held.

Trait Implementations

impl<'a> Clone for KeyEvent<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for KeyEvent<'a>

impl<'a> Debug for KeyEvent<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for KeyEvent<'a>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for KeyEvent<'a>