Struct hid_io::protocol::hidio::HIDIOPacketBuffer

#[repr(C)]
pub struct HIDIOPacketBuffer {
    pub ptype: HIDIOPacketType,
    pub id: u32,
    pub max_len: u32,
    pub data: Vec<u8>,
    pub done: bool,
}

HID-IO Packet Buffer Struct

Remarks

Used to store HID-IO data chunks. Will be chunked into individual packets on transmission.

Fields

ptype: HIDIOPacketType

Type of packet (Continued is automatically set if needed)

id: u32

Packet Id

max_len: u32

Packet length for serialization (in bytes)

data: Vec<u8>

Payload data, chunking is done automatically by serializer

done: bool

Set False if buffer is not complete, True if it is

Methods

impl HIDIOPacketBuffer

pub fn new() -> HIDIOPacketBuffer

Constructor for HIDIOPacketBuffer

Remarks

Initialize as blank

pub fn append_payload(&mut self, new_data: &mut Vec<u8>) -> bool

Append payload data

Arguments

• new_data - Vector of bytes

Remarks

Appends payload to HIDIOPacketBuffer.

pub fn decode_packet(
    &mut self,
    packet_data: &mut Vec<u8>
) -> Result<u32, HIDIOParseError>

Append packet stream Returns the number of bytes used.

Arguments

• packet_data - Vector of bytes of packet data

Remarks

Does packet decoding on the fly. Will set done parameter if this is the last packet.

pub fn serialize_buffer(&mut self) -> Result<Vec<u8>, HIDIOParseError>

Serialize HIDIOPacketBuffer

Remarks

Provides a raw data vector to the serialized data. Removes some of the header that Serialize from serde prepends.

Trait Implementations

impl Clone for HIDIOPacketBuffer

fn clone(&self) -> HIDIOPacketBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for HIDIOPacketBuffer

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<HIDIOPacketBuffer> for HIDIOPacketBuffer

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Display for HIDIOPacketBuffer

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

Display formatter for HIDIOPacketBuffer

impl Debug for HIDIOPacketBuffer

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

Formats the value using the given formatter.

impl Serialize for HIDIOPacketBuffer

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serializer for HIDIOPacketBuffer

Remarks

Determine cont, width, upper_len and len fields According to this C-Struct:

struct HIDIO_Packet {
   HIDIO_Packet_Type type:3;
   uint8_t           cont:1;      // 0 - Only packet, 1 continued packet following
   uint8_t           id_width:1;  // 0 - 16bits, 1 - 32bits
   uint8_t           reserved:1;  // Reserved
   uint8_t           upper_len:2; // Upper 2 bits of length field (generally unused)
   uint8_t           len;         // Lower 8 bits of length field
   uint8_t           data[0];     // Start of data payload (may start with Id)
};