Struct crossterm_winapi::KeyEventRecord

pub struct KeyEventRecord {
    pub key_down: bool,
    pub repeat_count: u16,
    pub virtual_key_code: WORD,
    pub virtual_scan_code: u16,
    pub u_char: KEY_EVENT_RECORD_uChar,
    pub control_key_state: ControlKeyState,
}

Describes a keyboard input event in a console INPUT_RECORD structure. link: [https://docs.microsoft.com/en-us/windows/console/key-event-record-str]

Fields

key_down: bool

If the key is pressed, this member is TRUE. Otherwise, this member is FALSE (the key is released).

repeat_count: u16

The repeat count, which indicates that a key is being held down. For example, when a key is held down, you might get five events with this member equal to 1, one event with this member equal to 5, or multiple events with this member greater than or equal to 1.

virtual_key_code: WORD

A virtual-key code that identifies the given key in a device-independent manner.

virtual_scan_code: u16

The virtual scan code of the given key that represents the device-dependent value generated by the keyboard hardware.

u_char: KEY_EVENT_RECORD_uChar

A union of the following members.

• UnicodeChar Translated Unicode character.

• AsciiChar Translated ASCII character. TODO, make this a rust type.

control_key_state: ControlKeyState

The state of the control keys.

Trait Implementations

impl From<KEY_EVENT_RECORD> for KeyEventRecord

fn from(event: KEY_EVENT_RECORD) -> Self

Performs the conversion.