Enum Event 

#[non_exhaustive]
pub enum Event {
    #[non_exhaustive]
    Button {
        button: Button,
        pressed: bool,
        at: Stamp,
    },
    #[non_exhaustive]
    Key {
        key: Key,
        pressed: bool,
        at: Stamp,
    },
    #[non_exhaustive]
    Media {
        key: MediaKey,
        pressed: bool,
        at: Stamp,
    },
    #[non_exhaustive]
    Motion {
        dx: i32,
        dy: i32,
        wheel: i32,
        pan: i32,
        at: Stamp,
    },
    #[non_exhaustive]
    Dropped {
        count: u64,
        source: DropSource,
    },
    SessionReset,
    #[non_exhaustive]
    Rejected {
        action: Action,
        count: u64,
    },
    Disconnected,
    Reconnected,
    Changed,
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

Button

a physical button

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

button: Button

pressed: bool

at: Stamp

#[non_exhaustive]

Key

a physical key on the keyboard behind the box. just know that you see every key typed there, passwords included

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

key: Key

pressed: bool

at: Stamp

#[non_exhaustive]

Media

a physical media key, like volume or play

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

key: MediaKey

pressed: bool

at: Stamp

#[non_exhaustive]

Motion

physical motion. the wheel is positive going up and pan (horizontal scroll) is positive going right

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

dx: i32

dy: i32

wheel: i32

pan: i32

at: Stamp

#[non_exhaustive]

Dropped

how many events never reached you since the last Dropped from the same source. one from the box can mean it restarted a stream, so what you knew about which physical buttons and keys were held may be out of date. the one for your own queue (DropSource::Host) sits at the front of the queue, not where the loss happened, and on Medius the one from the box comes from a box wide counter read about once a second, so it can also count what your own subscriptions through medius() lost

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

count: u64

source: DropSource

SessionReset

the box lost its state, so the buttons and keys you were holding got released (on a box with Quirk::KeepsHeld they stay held). what you knew about which physical buttons and keys were held is out of date too, because one held through the reset can show a second press or never show its release

#[non_exhaustive]

Rejected

the box refused something after the call already returned ok, MAKCU does that when its command queue is full. slow down and send it again if it mattered. count is how many of that action got refused since you last read one, so a flood of refusals never pushes your input out of the queue

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

action: Action

count: u64

Disconnected

Reconnected

the box is back, the buttons and keys you were holding got released (on a box with Quirk::KeepsHeld they stay held), and the snapshot may have changed. on a MAKCU you also get this when a mouse or keyboard gets plugged into the box or pulled out, and on a Medius when the device it clones gets swapped. what you knew about which physical buttons and keys were held is out of date, same as after SessionReset

Changed

the snapshot changed with no reconnect, so read snapshot() again. a mouse or keyboard set or pulled on a Ferrum, a YSC turning its keys off, or a Medius clone whose details changed come this way. so does a Ferrum unplugged from this PC, because the app’s port stays open and the app just loses its devices, and once it’s back you get a SessionReset after this one, since the box forgot its locks. a MAKCU gets a Reconnected for those instead, so watch both. two of these never wait unread in the same receiver

Implementations

impl Event

for tests and for code that builds events itself. the variants stay #[non_exhaustive] so a field added later doesn’t break anyone, and these are how you make them from outside

pub fn button(button: Button, pressed: bool, at: Stamp) -> Self

pub fn key(key: Key, pressed: bool, at: Stamp) -> Self

pub fn media(key: MediaKey, pressed: bool, at: Stamp) -> Self

pub fn motion(dx: i32, dy: i32, wheel: i32, pan: i32, at: Stamp) -> Self

pub fn dropped(count: u64, source: DropSource) -> Self

pub fn rejected(action: Action, count: u64) -> Self

impl Event

pub fn examples(at: Stamp) -> Vec<Event>

one of each event with every field it has filled in, for testing how code handles them with no box. the input ones carry at as their host time and a fixed box time

Trait Implementations

impl Clone for Event

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Eq for Event

impl PartialEq for Event

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Event