Struct Key 

pub struct Key {
    pub text: String,
    pub mod_keys: KeyMod,
    pub code: char,
    pub shifted_code: Option<char>,
    pub base_code: Option<char>,
    pub is_repeat: bool,
}

Key represents a Key press or release event in v2.0.8.

Fields

text: String

Text contains actual characters received.

mod_keys: KeyMod

Modifier keys pressed.

code: char

Key code character/rune.

shifted_code: Option<char>

Shifted key code.

base_code: Option<char>

Base key code on US PC-101 layout.

is_repeat: bool

Whether key is auto-repeating.

Implementations

impl Key

pub fn new(code: char, text: &str, mod_keys: KeyMod) -> Self

Creates a new simple Key.

pub fn string(&self) -> String

String representation of key event. Returns “space” for spacebar.

pub fn keystroke(&self) -> String

Keystroke representation with explicit modifier ordering (ctrl+alt+shift...).

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl PartialEq for Key

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Key