Struct winconsole::input::KeyEvent

pub struct KeyEvent {
    pub character: char,
    pub key_code: KeyCode,
    pub modifiers: ControlKeyState,
    pub pressed: bool,
    pub repeat_count: u16,
    pub scan_code: u16,
}

Represents an input event which occurred on the keyboard.

Fields

character: char

The character associated with the pressed key.

key_code: KeyCode

The KeyCode of the key which the event occurred on.

modifiers: ControlKeyState

A ControlKeyState object describing the state of control keys.

pressed: bool

Is the key pressed?

repeat_count: u16

The amount of times the event was repeated in the input buffer.

scan_code: u16

The scan code of the key.

Methods

impl KeyEvent

pub fn new() -> KeyEvent

Returns an empty KeyEvent.

Trait Implementations

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 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 Into<InputEvent> for KeyEvent

fn into(self) -> InputEvent

Performs the conversion.

impl Copy for KeyEvent

impl Debug for KeyEvent

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

Formats the value using the given formatter.

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