Struct ReportId 

pub struct ReportId(/* private fields */);

Unsigned value that specifies the Report ID.

If a Report ID tag is used anywhere in Report descriptor, all data reports for the device are preceded by a single byte ID field. All items succeeding the first Report ID tag but preceding a second Report ID tag are included in a report prefixed by a 1-byte ID. All items succeeding the second but preceding a third Report ID tag are included in a second report prefixed by a second ID, and so on.

This Report ID value indicates the prefix added to a particular report. For example, a Report descriptor could define a 3-byte report with a Report ID of 01. This device would generate a 4-byte data report in which the first byte is 01. The device may also generate other reports, each with a unique ID. This allows the host to distinguish different types of reports arriving over a single interrupt in pipe. And allows the device to distinguish different types of reports arriving over a single interrupt out pipe. Report ID zero is reserved and should not be used.

Implementations

impl ReportId

pub const PREFIX: u8 = 132u8

Prefix consists of tag(bit 7-4), type(bit 3-2) and size(bit 1-0). The “size” part is set to 00 in this constant value.

pub fn new(raw: &[u8]) -> Result<Self, HidError>

Create an item with prefix check.

pub unsafe fn new_unchecked(raw: &[u8]) -> Self

Create an item WITHOUT prefix check.

Safety

Must ensure that the prefix part is correct.

pub fn prefix(&self) -> u8

Get prefix part of the item. Equivalent to item.as_ref()[0].

pub fn data(&self) -> &[u8]

Get data part of the item. Equivalent to &item.as_ref()[1..].

pub fn new_with(data: &[u8]) -> Result<Self, HidError>

Create an item with specific data.

NOTE: data size must be: 0, 1, 2 or 4.

pub fn set_data(&mut self, data: &[u8]) -> Result<&mut Self, HidError>

Set data part of the item.

NOTE: data size must be: 0, 1, 2 or 4.

pub fn data_mut(&mut self) -> &mut [u8]

Get mutable data part of the item.

Trait Implementations

impl AsRef<[u8]> for ReportId

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ReportId

fn clone(&self) -> ReportId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReportId

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

Formats the value using the given formatter.

impl Default for ReportId

fn default() -> Self

Returns the “default value” for a type.

impl Display for ReportId

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

Formats the value using the given formatter.

impl PartialEq for ReportId

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

impl StructuralPartialEq for ReportId