Struct KeyData 

pub struct KeyData {
    pub key: Key,
    pub key_state: KeyState,
}

height-level key data wrapper

Fields

key: Key

key_state: KeyState

Implementations

impl KeyData

pub fn new(c: char) -> Result<Self>

Create key data from char

pub fn supports_modifiers(&self) -> bool

check if the modifier key is supported.

pub fn r_shift(&self) -> bool

check if the right shift is pressed.

pub fn l_shift(&self) -> bool

check if the left shift is pressed.

pub fn shift(&self) -> bool

check if any shift is pressed.

pub fn r_ctrl(&self) -> bool

check if the right control is pressed.

pub fn l_ctrl(&self) -> bool

check if the left control is pressed.

pub fn ctrl(&self) -> bool

check if any control is pressed.

pub fn r_alt(&self) -> bool

check if the right alt is pressed.

pub fn l_alt(&self) -> bool

check if the left alt is pressed.

pub fn alt(&self) -> bool

check if any alt is pressed.

pub fn r_logo(&self) -> bool

check if the right logo is pressed.

pub fn l_logo(&self) -> bool

check if the left logo is pressed.

pub fn logo(&self) -> bool

check if any logo is pressed.

pub fn menu(&self) -> bool

check if the menu is pressed.

pub fn sys_req(&self) -> bool

check if the sys req is pressed.

pub fn supports_toggles(&self) -> bool

check if the toggle state is supported.

pub fn is_realtime_mode(&self) -> bool

check if realtime mode is active. but inconsistent keyboard input behavior across different vendors :(

pub fn scroll_lock(&self) -> bool

check if the scroll lock is active.

pub fn num_lock(&self) -> bool

check if the num lock is active.

pub fn caps_lock(&self) -> bool

check if the caps lock is active.

pub fn realtime_init(stdin: &mut ScopedProtocol<Input>, enable: bool) -> Result

initialize realtime mode. warn: this init function could overwrite the existing toggle state. warn: it is recommended to call this function at program startup.

Trait Implementations

impl Clone for KeyData

fn clone(&self) -> KeyData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyData

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

Formats the value using the given formatter.

impl From<KeyData> for RawKeyData

reverse conversion to C struct

fn from(value: KeyData) -> Self

Converts to this type from the input type.

impl From<RawKeyData> for KeyData

forward conversion to Rust struct

fn from(raw: RawKeyData) -> Self

Converts to this type from the input type.

impl Copy for KeyData