Struct Input 

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

Refers to the data from one or more similar controls on a device.

For example, variable data such as reading the position of a single axis or a group of levers or array data such as one or more push buttons or switches.

Data (Little-Endian)

• Bit 0: Data(0) | Constant(1)
• Bit 1: Array(0) | Variable(1)
• Bit 2: Absolute(0) | Relative(1)
• Bit 3: No Wrap(0) | Wrap(1)
• Bit 4: Linear(0) | Non Linear(1)
• Bit 5: Preferred State(0) | No Preferred(1)
• Bit 6: No Null Position(0) | Null State(1)
• Bit 7: Reserved
• Bit 8: Bit Field(0) | Buffered Bytes(1)
• Bit 31-9: Reserved

Implementations

impl Input

pub const PREFIX: u8 = 0b1000_0000

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 Input

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

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

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Input

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

Formats the value using the given formatter.

impl Default for Input

fn default() -> Self

Returns the “default value” for a type.

impl Display for Input

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

Formats the value using the given formatter.

impl PartialEq for Input

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

impl StructuralPartialEq for Input