Struct 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.

Implementations

impl KeyEvent

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

Creates a new KeyEvent

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

Formats the value using the given formatter.

impl From<KeyCode> for KeyEvent

fn from(code: KeyCode) -> Self

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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 TryFrom<Key> for KeyEvent

Available on crate feature termion only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(key: Key) -> Result<KeyEvent>

Performs the conversion.

impl TryFrom<KeyEvent> for KeyEvent

Available on crate feature crossterm only.

type Error = ()

The type returned in the event of a conversion error.

fn try_from(event: KeyEvent) -> Result<Self, ()>

Performs the conversion.

impl Copy for KeyEvent

impl Eq for KeyEvent

impl StructuralPartialEq for KeyEvent