Struct crossterm::event::KeyEvent

pub struct KeyEvent {
    pub code: KeyCode,
    pub modifiers: KeyModifiers,
}

Represents a key event.

Fields

code: KeyCode

The key itself.

modifiers: KeyModifiers

Additional key modifiers.

Methods

impl KeyEvent

pub fn new(code: KeyCode, modifiers: KeyModifiers) -> KeyEvent

Trait Implementations

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for KeyEvent

impl Debug for KeyEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for KeyEvent

impl From<KeyCode> for KeyEvent

fn from(code: KeyCode) -> Self

Performs the conversion.

impl Hash for KeyEvent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<KeyEvent> for KeyEvent

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<KeyEvent> for KeyEvent

fn partial_cmp(&self, other: &KeyEvent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &KeyEvent) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &KeyEvent) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &KeyEvent) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &KeyEvent) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for KeyEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for KeyEvent

impl StructuralPartialEq for KeyEvent