Struct HidDevice 

#[repr(C)]
pub struct HidDevice {
    pub vendor_id: u16,
    pub product_id: u16,
    pub usage_page: u16,
    pub usage: u16,
    pub name: AzString,
    pub serial: AzString,
    pub instance: u64,
}

Identity of one HID device.

The four numbers are the HID descriptor’s own vocabulary, not azul’s: usage_page + usage say what KIND of device it claims to be (page 0x01 usage 0x04 is a joystick, 0x05 a gamepad, 0x08 a multi-axis controller), while vendor and product identify the model. An app matches on whichever pair it needs — usage for “any joystick”, vid/pid for “this exact wheel”.

Fields

vendor_id: u16

USB vendor id.

product_id: u16

USB product id.

usage_page: u16

HID usage page of the device’s top-level collection.

usage: u16

HID usage within that page.

name: AzString

Human-readable product string, empty when the device reports none.

serial: AzString

The device’s SERIAL NUMBER as it reports it (USB iSerial; a DualSense reports its Bluetooth address), empty when it reports none or the platform does not expose it (Windows, see the backend).

instance: u64

PER-INSTANCE identity (8f-i-a-i, user ruling: two identical pads must stay distinct for multiplayer). Stable for the device’s connected lifetime and never 0 for a real device. Derived from vendor, product and serial when a serial is reported - so it survives a reconnect - and from the platform’s own handle for the device otherwise, which is unique among the devices present but may change when the device is re-plugged. Reports carry it, so an app keyed on this field reads each pad’s stream apart from its twin’s.

Implementations

impl HidDevice

pub fn serial_instance( vendor_id: u16, product_id: u16, serial: &str, ) -> Option<u64>

The reconnect-stable instance id of a device with a serial number: an FNV-1a hash over vendor, product and serial. None when the device reports no serial - the caller falls back to its platform handle through Self::handle_instance.

pub fn handle_instance(handle: &[u8]) -> u64

An instance id from a platform handle (a device path, a kernel object address, a hidraw number) for a device with no serial. Never 0, so “no identity” stays distinguishable from a real one.

pub fn instance_for( vendor_id: u16, product_id: u16, serial: &str, handle: &[u8], ) -> u64

The instance id for this device’s identity: the serial-derived one when a serial is present, else the handle-derived one.

Trait Implementations

impl Clone for HidDevice

fn clone(&self) -> HidDevice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HidDevice

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

Formats the value using the given formatter.

impl Eq for HidDevice

impl FromIterator<HidDevice> for HidDeviceVec

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = HidDevice>,

Creates a value from an iterator.

impl Hash for HidDevice

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for HidDevice

fn cmp(&self, other: &HidDevice) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for HidDevice

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for HidDevice

fn partial_cmp(&self, other: &HidDevice) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for HidDevice