Struct OpenUsbDevice

pub struct OpenUsbDevice { /* private fields */ }

An opened USB device.

Dropping this causes the USB device to be closed.

Implementations

impl OpenUsbDevice

pub fn device(&self) -> &UsbDevice

The USB device.

pub async fn close(self) -> Result<()>

Releases all open interfaces and ends the device session.

It is not necessary to call this method, since dropping OpenUsbDevice will also close the USB device.

pub async fn reset(&self) -> Result<()>

Resets the device and cancels all pending operations.

pub async fn select_configuration(&self, configuration: u8) -> Result<()>

Selects the USB device configuration with the specified index.

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

Claim specified interface for exclusive access.

pub async fn release_interface(&self, interface: u8) -> Result<()>

Release specified interface from exclusive access.

pub async fn select_alternate_interface( &self, interface: u8, alternate: u8, ) -> Result<()>

Selects the alternate setting with the specified index for an interface.

pub async fn clear_halt( &self, direction: UsbDirection, endpoint: u8, ) -> Result<()>

Clears a halt condition.

A halt condition is when a data transfer to or from the device has a status of ‘stall’, which requires the web page (the host system, in USB terminology) to clear that condition.

pub async fn control_transfer_in( &self, control_request: &UsbControlRequest, len: u16, ) -> Result<Vec<u8>>

Perform a control transfer from device to host.

pub async fn control_transfer_out( &self, control_request: &UsbControlRequest, data: &[u8], ) -> Result<u32>

Perform a control transfer from host to device.

pub async fn isochronous_transfer_in( &self, endpoint: u8, packet_lens: impl IntoIterator<Item = u32>, ) -> Result<Vec<Result<Vec<u8>>>>

Transmits time sensitive information from the device.

pub async fn isochronous_transfer_out( &self, endpoint: u8, packets: impl IntoIterator<Item = &[u8]>, ) -> Result<Vec<Result<u32>>>

Transmits time sensitive information to the device.

Returns the number of bytes sent of each packet.

pub async fn transfer_in(&self, endpoint: u8, len: u32) -> Result<Vec<u8>>

Performs a bulk or interrupt transfer from specified endpoint of the device.

pub async fn transfer_out(&self, endpoint: u8, data: &[u8]) -> Result<u32>

Performs a bulk or interrupt transfer to the specified endpoint of the device.

Returns the number of bytes sent.

Trait Implementations

impl AsRef<UsbDevice> for OpenUsbDevice

fn as_ref(&self) -> &UsbDevice

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

impl Debug for OpenUsbDevice

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

Formats the value using the given formatter.

impl Drop for OpenUsbDevice

fn drop(&mut self)

Executes the destructor for this type.