Struct nusb::Device

pub struct Device { /* private fields */ }

An opened USB device.

Obtain a Device by calling DeviceInfo::open:

use nusb;
let device_info = nusb::list_devices().unwrap()
    .find(|dev| dev.vendor_id() == 0xAAAA && dev.product_id() == 0xBBBB)
    .expect("device not connected");

let device = device_info.open().expect("failed to open device");
let interface = device.claim_interface(0);

This type is reference-counted with an Arc internally, and can be cloned cheaply for use in multiple places in your program. The device is closed when all clones and all associated Interfaces are dropped.

Use .claim_interface(i) to open an interface to submit transfers.

Implementations

impl Device

pub fn claim_interface(&self, interface: u8) -> Result<Interface, Error>

Open an interface of the device and claim it for exclusive use.

pub fn detach_and_claim_interface( &self, interface: u8 ) -> Result<Interface, Error>

Detach kernel drivers and open an interface of the device and claim it for exclusive use.

Platform notes

This function can only detach kernel drivers on Linux. Calling on other platforms has the same effect as claim_interface.

pub fn active_configuration( &self ) -> Result<Configuration<'_>, ActiveConfigurationError>

Get information about the active configuration.

This returns cached data and does not perform IO. However, it can fail if the device is unconfigured, or if it can’t find a configuration descriptor for the configuration reported as active by the OS.

pub fn configurations(&self) -> impl Iterator<Item = Configuration<'_>>

Get an iterator returning information about each configuration of the device.

This returns cached data and does not perform IO.

pub fn set_configuration(&self, configuration: u8) -> Result<(), Error>

Set the device configuration.

The argument is the desired configuration’s bConfigurationValue descriptor field from Configuration::configuration_value or 0 to unconfigure the device.

Platform-specific notes

• Not supported on Windows

pub fn get_descriptor( &self, desc_type: u8, desc_index: u8, language_id: u16, timeout: Duration ) -> Result<Vec<u8>, Error>

Request a descriptor from the device.

The language_id should be 0 unless you are requesting a string descriptor.

Platform-specific details

• On Windows, the timeout argument is ignored, and an OS-defined timeout is used.
• On Windows, this does not wake suspended devices. Reading their descriptors will return an error.

pub fn get_string_descriptor_supported_languages( &self, timeout: Duration ) -> Result<impl Iterator<Item = u16>, Error>

Request the list of supported languages for string descriptors.

Platform-specific details

See notes on get_descriptor.

pub fn get_string_descriptor( &self, desc_index: u8, language_id: u16, timeout: Duration ) -> Result<String, Error>

Request a string descriptor from the device.

Almost all devices support only the language ID US_ENGLISH.

Unpaired UTF-16 surrogates will be replaced with �, like String::from_utf16_lossy.

Platform-specific details

See notes on get_descriptor.

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

Reset the device, forcing it to re-enumerate.

This Device will no longer be usable, and you should drop it and call super::list_devices to find and re-open it again.

Platform-specific notes

• Not supported on Windows

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

Returns a copy of the value.

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

Performs copy-assignment from source.