Struct crossterm_winapi::KeyEventRecord

pub struct KeyEventRecord {
    pub key_down: bool,
    pub repeat_count: u16,
    pub virtual_key_code: u16,
    pub virtual_scan_code: u16,
    pub u_char: u16,
    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: u16

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: u16

The translated Unicode character (as a WCHAR, or utf-16 value)

control_key_state: ControlKeyState

The state of the control keys.

Trait Implementations

impl Clone for KeyEventRecord

fn clone(&self) -> KeyEventRecord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyEventRecord

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

Formats the value using the given formatter.

impl Eq for KeyEventRecord

impl PartialEq<KeyEventRecord> for KeyEventRecord

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

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

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

This method tests for !=.

impl StructuralEq for KeyEventRecord

impl StructuralPartialEq for KeyEventRecord