Struct playdate_device::device::DeviceInfo

pub struct DeviceInfo { /* private fields */ }

Information about a device that can be obtained without opening it.

Found in the results of crate::list_devices.

Platform-specific notes

• Some fields are platform-specific
  • Linux: sysfs_path
  • Windows: instance_id, parent_instance_id, port_number, driver
  • macOS: registry_id, location_id

Implementations

impl DeviceInfo

pub fn sysfs_path(&self) -> &Path

(Linux-only) Sysfs path for the device.

pub fn bus_number(&self) -> u8

Number identifying the bus / host controller where the device is connected.

pub fn device_address(&self) -> u8

Number identifying the device within the bus.

pub fn vendor_id(&self) -> u16

The 16-bit number identifying the device’s vendor, from the idVendor device descriptor field.

pub fn product_id(&self) -> u16

The 16-bit number identifying the product, from the idProduct device descriptor field.

pub fn device_version(&self) -> u16

The device version, normally encoded as BCD, from the bcdDevice device descriptor field.

pub fn class(&self) -> u8

Code identifying the standard device class, from the bDeviceClass device descriptor field.

0x00: specified at the interface level.
0xFF: vendor-defined.

pub fn subclass(&self) -> u8

Standard subclass, from the bDeviceSubClass device descriptor field.

pub fn protocol(&self) -> u8

Standard protocol, from the bDeviceProtocol device descriptor field.

pub fn speed(&self) -> Option<Speed>

Connection speed

pub fn manufacturer_string(&self) -> Option<&str>

Manufacturer string, if available without device IO.

Platform-specific notes

• Windows: Windows does not cache the manufacturer string, and this will return None regardless of whether a descriptor exists.

pub fn product_string(&self) -> Option<&str>

Product string, if available without device IO.

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

Serial number string, if available without device IO.

Platform-specific notes

• On Windows, this comes from a case-insensitive instance ID and may have been converted to upper case from the descriptor string. It is recommended to use a case-insensitive comparison when matching a device.

pub fn interfaces(&self) -> impl Iterator<Item = &InterfaceInfo>

Iterator over the device’s interfaces.

This returns summary information about the interfaces in the device’s active configuration for the purposes of matching devices prior to opening them.

Additional information about interfaces can be found in the configuration descriptor after opening the device by calling Device::active_configuration.

Platform-specific notes:

• Windows: this is only available for composite devices bound to the usbccgp driver, and will be empty if the entire device is bound to a specific driver.
• Windows: When interfaces are grouped by an interface association descriptor, this returns details from the interface association descriptor and does not include each of the associated interfaces.

pub fn open(&self) -> Result<Device, Error>

Open the device

Trait Implementations

impl AsRef<DeviceInfo> for Device

fn as_ref(&self) -> &DeviceInfo

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

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<(), Error>

Formats the value using the given formatter.

impl DeviceMode for DeviceInfo

fn mode(&self) -> Mode

USB device mode determined by the product ID.

impl HaveDataInterface for DeviceInfo

fn data_interface_number(&self) -> Option<u8>

fn have_data_interface(&self) -> bool

impl MassStorageInterface for DeviceInfo

fn storage_interface(&self) -> Option<&InterfaceInfo>

fn have_storage_interface(&self) -> bool

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 136 bytes