Struct KeyboardReport 

pub struct KeyboardReport {
    pub modifiers: u8,
    pub keycodes: [u8; 6],
}

Decoded keyboard report (USB HID boot protocol, 8 bytes).

All standard USB keyboards support this layout when placed in boot protocol mode via HidHost::set_protocol with PROTOCOL_BOOT.

Fields

modifiers: u8

Modifier keys bitmask.

Bit 0: Left Ctrl | Bit 1: Left Shift | Bit 2: Left Alt | Bit 3: Left GUI Bit 4: Right Ctrl | Bit 5: Right Shift | Bit 6: Right Alt | Bit 7: Right GUI

keycodes: [u8; 6]

Up to 6 simultaneously pressed key codes (HID usage page 0x07). A value of 0x00 means “no key”; 0x01 means “rollover error”.

Implementations

impl KeyboardReport

pub fn parse(buf: &[u8]) -> Option<Self>

Parse a boot-protocol keyboard report from an 8-byte buffer. Returns None if the buffer is shorter than 8 bytes.

pub fn is_pressed(&self, keycode: u8) -> bool

Returns true if the given HID key code is currently pressed.

pub fn ctrl(&self) -> bool

Returns true if Left Ctrl or Right Ctrl is held.

pub fn shift(&self) -> bool

Returns true if Left Shift or Right Shift is held.

pub fn alt(&self) -> bool

Returns true if Left Alt or Right Alt is held.

pub fn gui(&self) -> bool

Returns true if Left GUI (Win/Cmd) or Right GUI is held.

Trait Implementations

impl Clone for KeyboardReport

fn clone(&self) -> KeyboardReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardReport

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

Formats the value using the given formatter.

impl Default for KeyboardReport

fn default() -> KeyboardReport

Returns the “default value” for a type.

impl Format for KeyboardReport

where [u8; 6]: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl PartialEq for KeyboardReport

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

impl StructuralPartialEq for KeyboardReport