Struct MouseReport 

pub struct MouseReport {
    pub buttons: MouseButtons,
    pub x: i8,
    pub y: i8,
    pub wheel: i8,
}

Decoded mouse report (USB HID boot protocol, 4 bytes).

All standard USB mice support this layout in boot protocol mode.

Fields

buttons: MouseButtons

Button state. Use the MouseButtons constants or check bits directly.

x: i8

Horizontal movement since last report (signed, positive = right).

y: i8

Vertical movement since last report (signed, positive = down).

wheel: i8

Scroll wheel movement (signed, positive = scroll up / away from user).

Implementations

impl MouseReport

pub const BUTTON_LEFT: MouseButtons = 1u8

Left mouse button.

pub const BUTTON_RIGHT: MouseButtons = 2u8

Right mouse button.

pub const BUTTON_MIDDLE: MouseButtons = 4u8

Middle mouse button (scroll wheel click).

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

Parse a boot-protocol mouse report from a buffer (minimum 3 bytes; 4 for wheel). Returns None if the buffer is shorter than 3 bytes.

pub fn left(&self) -> bool

Returns true if the left button is pressed.

pub fn right(&self) -> bool

Returns true if the right button is pressed.

pub fn middle(&self) -> bool

Returns true if the middle button is pressed.

Trait Implementations

impl Clone for MouseReport

fn clone(&self) -> MouseReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MouseReport

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

Formats the value using the given formatter.

impl Default for MouseReport

fn default() -> MouseReport

Returns the “default value” for a type.

impl Format for MouseReport

where MouseButtons: Format,

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

Writes the defmt representation of self to fmt.

impl PartialEq for MouseReport

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

impl StructuralPartialEq for MouseReport