Struct KeyboardModifiers

pub struct KeyboardModifiers { /* private fields */ }

Bool flags for each of the modifier keys (left ctrl, etc.).

Implementations

impl KeyboardModifiers

pub const LEFT_CTRL: KeyboardModifiers

Const for left ctrl.

pub const LEFT_SHIFT: KeyboardModifiers

Const for left shift.

pub const LEFT_ALT: KeyboardModifiers

Const for left alt.

pub const LEFT_GUI: KeyboardModifiers

Const for left gui.

pub const RIGHT_CTRL: KeyboardModifiers

Const for right ctrl.

pub const RIGHT_SHIFT: KeyboardModifiers

Const for right shift.

pub const RIGHT_ALT: KeyboardModifiers

Const for right alt.

pub const RIGHT_GUI: KeyboardModifiers

Const for right gui.

pub const fn new() -> Self

Constructs with modifiers defaulting to false.

pub const fn from_key_code(key_code: u8) -> Option<Self>

Constructs with the given key_code.

Returns None if the key_code is not a modifier key code.

pub const fn is_modifier_key_code(key_code: u8) -> bool

Predicate for whether the key code is a modifier key code.

pub fn as_key_codes(&self) -> Vec<u8, 8>

Constructs a Vec of key codes from the modifiers.

pub fn as_byte(&self) -> u8

Constructs the byte for the modifiers of an HID keyboard report.

pub const fn union(&self, other: &KeyboardModifiers) -> KeyboardModifiers

Union of two KeyboardModifiers, taking “or” of each modifier.

Trait Implementations

impl Clone for KeyboardModifiers

fn clone(&self) -> KeyboardModifiers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardModifiers

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

Formats the value using the given formatter.

impl Default for KeyboardModifiers

fn default() -> KeyboardModifiers

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyboardModifiers

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for KeyboardModifiers

fn eq(&self, other: &KeyboardModifiers) -> 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 Copy for KeyboardModifiers

impl Eq for KeyboardModifiers

impl StructuralPartialEq for KeyboardModifiers