Struct DeviceInfo

pub struct DeviceInfo {
    pub id: DeviceId,
    pub name: String,
    pub product_id: u16,
    pub vendor_id: u16,
    pub usage_id: u16,
    pub usage_page: u16,
    /* private fields */
}

A struct containing basic information about a device

This struct can be obtained by calling DeviceInfo::enumerate and upgraded into a usable Device by calling DeviceInfo::open.

Fields

id: DeviceId

OS specific identifier

name: String

The human readable name

product_id: u16

The HID product id assigned to this device

vendor_id: u16

The HID vendor id of the device’s manufacturer (i.e Logitech = 0x46D)

usage_id: u16

The HID usage id

usage_page: u16

The HID usage page

Implementations

impl DeviceInfo

pub fn enumerate() -> impl Future<Output = HidResult<impl Stream<Item = DeviceInfo> + Unpin + Send>>

Enumerates all accessible HID devices

If this library fails to retrieve the DeviceInfo of a device it will be automatically excluded. Register a log compatible logger at trace level for more information about the discarded devices.

pub async fn open(&self, mode: AccessMode) -> HidResult<Device>

Opens the associated device in the requested AccessMode

pub fn matches( &self, usage_page: u16, usage_id: u16, vendor_id: u16, product_id: u16, ) -> bool

Convenience method for easily finding a specific device

Trait Implementations

impl Clone for DeviceInfo

fn clone(&self) -> DeviceInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceInfo

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

Formats the value using the given formatter.

impl Hash for DeviceInfo

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 PartialEq for DeviceInfo

fn eq(&self, other: &Self) -> 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 SerialNumberExt for DeviceInfo

fn serial_number(&self) -> Option<&str>

impl Eq for DeviceInfo