Enum ChannelObservation 

#[non_exhaustive]
pub enum ChannelObservation {
    OutgoingReport {
        request_id: Option<u64>,
        report: ObservedReport,
    },
    IncomingReport {
        request_id: Option<u64>,
        report: ObservedReport,
    },
    MalformedIncomingReport {
        report: ObservedReport,
    },
    ForeignIncomingReport {
        report: ObservedReport,
    },
    RequestOutcome {
        request_id: u64,
        outcome: RequestOutcome,
    },
}

A wire or request-lifecycle fact observed by a HidppChannel.

Request IDs are monotonically assigned within one channel lifetime. An outgoing report with request_id: None is a fire-and-forget HID++ write or a HidppChannel::write_raw_report write. A parsed incoming report has an ID only when the channel matched it to a pending request; None therefore identifies unsolicited or late input.

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.

OutgoingReport

A post-normalization report submitted to the raw transport.

Fields

request_id: Option<u64>

The pending request this report belongs to, if it expects a response.

report: ObservedReport

The exact bytes passed to the raw transport.

IncomingReport

A valid HID++ report read from the raw transport.

Fields

request_id: Option<u64>

The request whose predicate matched this report, if any.

report: ObservedReport

The exact bytes returned by the raw transport.

MalformedIncomingReport

Raw incoming bytes carrying a HID++ report ID that failed HID++ report parsing.

Fields

report: ObservedReport

The exact bytes returned by the raw transport.

ForeignIncomingReport

An incoming report belonging to another protocol sharing this node — Logitech DJ (0x20/0x21) on a Unifying receiver, for instance. It says nothing about the HID++ exchange and the channel drops it.

Fields

report: ObservedReport

The exact bytes returned by the raw transport.

RequestOutcome

The terminal outcome of a request that expected a response.

Fields

request_id: u64

The request whose lifecycle ended.

outcome: RequestOutcome

How the request ended.

Trait Implementations

impl Clone for ChannelObservation

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 ChannelObservation

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

Formats the value using the given formatter.

impl Eq for ChannelObservation

impl PartialEq for ChannelObservation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ChannelObservation