[−][src]Struct rusb::DeviceHandle
A handle to an open USB device.
Methods
impl<T: UsbContext> DeviceHandle<T>
[src]
pub fn as_raw(&self) -> *mut libusb_device_handle
[src]
Get the raw libusb_device_handle pointer, for advanced use in unsafe code.
This structure tracks claimed interfaces, and will get out if sync if interfaces are manipulated externally. Use only libusb endpoint IO functions.
pub fn active_configuration(&self) -> Result<u8>
[src]
Returns the active configuration number.
pub fn set_active_configuration(&mut self, config: u8) -> Result<()>
[src]
Sets the device's active configuration.
pub fn unconfigure(&mut self) -> Result<()>
[src]
Puts the device in an unconfigured state.
pub fn reset(&mut self) -> Result<()>
[src]
Resets the device.
pub fn clear_halt(&mut self, endpoint: u8) -> Result<()>
[src]
Clear the halt/stall condition for an endpoint.
pub fn kernel_driver_active(&self, iface: u8) -> Result<bool>
[src]
Indicates whether the device has an attached kernel driver.
This method is not supported on all platforms.
pub fn detach_kernel_driver(&mut self, iface: u8) -> Result<()>
[src]
Detaches an attached kernel driver from the device.
This method is not supported on all platforms.
pub fn attach_kernel_driver(&mut self, iface: u8) -> Result<()>
[src]
Attaches a kernel driver to the device.
This method is not supported on all platforms.
pub fn claim_interface(&mut self, iface: u8) -> Result<()>
[src]
Claims one of the device's interfaces.
An interface must be claimed before operating on it. All claimed interfaces are released when the device handle goes out of scope.
pub fn release_interface(&mut self, iface: u8) -> Result<()>
[src]
Releases a claimed interface.
pub fn set_alternate_setting(&mut self, iface: u8, setting: u8) -> Result<()>
[src]
Sets an interface's active setting.
pub fn read_interrupt(
&self,
endpoint: u8,
buf: &mut [u8],
timeout: Duration
) -> Result<usize>
[src]
&self,
endpoint: u8,
buf: &mut [u8],
timeout: Duration
) -> Result<usize>
Reads from an interrupt endpoint.
This function attempts to read from the interrupt endpoint with the address given by the
endpoint
parameter and fills buf
with any data received from the endpoint. The function
blocks up to the amount of time specified by timeout
.
If the return value is Ok(n)
, then buf
is populated with n
bytes of data received
from the endpoint.
Errors
If this function encounters any form of error while fulfilling the transfer request, an error variant will be returned. If an error variant is returned, no bytes were read.
The errors returned by this function include:
InvalidParam
if the endpoint is not an input endpoint.Timeout
if the transfer timed out.Pipe
if the endpoint halted.Overflow
if the device offered more data.NoDevice
if the device has been disconnected.Io
if the transfer encountered an I/O error.
pub fn write_interrupt(
&self,
endpoint: u8,
buf: &[u8],
timeout: Duration
) -> Result<usize>
[src]
&self,
endpoint: u8,
buf: &[u8],
timeout: Duration
) -> Result<usize>
Writes to an interrupt endpoint.
This function attempts to write the contents of buf
to the interrupt endpoint with the
address given by the endpoint
parameter. The function blocks up to the amount of time
specified by timeout
.
If the return value is Ok(n)
, then n
bytes of buf
were written to the endpoint.
Errors
If this function encounters any form of error while fulfilling the transfer request, an error variant will be returned. If an error variant is returned, no bytes were written.
The errors returned by this function include:
InvalidParam
if the endpoint is not an output endpoint.Timeout
if the transfer timed out.Pipe
if the endpoint halted.NoDevice
if the device has been disconnected.Io
if the transfer encountered an I/O error.
pub fn read_bulk(
&self,
endpoint: u8,
buf: &mut [u8],
timeout: Duration
) -> Result<usize>
[src]
&self,
endpoint: u8,
buf: &mut [u8],
timeout: Duration
) -> Result<usize>
Reads from a bulk endpoint.
This function attempts to read from the bulk endpoint with the address given by the
endpoint
parameter and fills buf
with any data received from the endpoint. The function
blocks up to the amount of time specified by timeout
.
If the return value is Ok(n)
, then buf
is populated with n
bytes of data received
from the endpoint.
Errors
If this function encounters any form of error while fulfilling the transfer request, an error variant will be returned. If an error variant is returned, no bytes were read.
The errors returned by this function include:
InvalidParam
if the endpoint is not an input endpoint.Timeout
if the transfer timed out.Pipe
if the endpoint halted.Overflow
if the device offered more data.NoDevice
if the device has been disconnected.Io
if the transfer encountered an I/O error.
pub fn write_bulk(
&self,
endpoint: u8,
buf: &[u8],
timeout: Duration
) -> Result<usize>
[src]
&self,
endpoint: u8,
buf: &[u8],
timeout: Duration
) -> Result<usize>
Writes to a bulk endpoint.
This function attempts to write the contents of buf
to the bulk endpoint with the address
given by the endpoint
parameter. The function blocks up to the amount of time specified
by timeout
.
If the return value is Ok(n)
, then n
bytes of buf
were written to the endpoint.
Errors
If this function encounters any form of error while fulfilling the transfer request, an error variant will be returned. If an error variant is returned, no bytes were written.
The errors returned by this function include:
InvalidParam
if the endpoint is not an output endpoint.Timeout
if the transfer timed out.Pipe
if the endpoint halted.NoDevice
if the device has been disconnected.Io
if the transfer encountered an I/O error.
pub fn read_control(
&self,
request_type: u8,
request: u8,
value: u16,
index: u16,
buf: &mut [u8],
timeout: Duration
) -> Result<usize>
[src]
&self,
request_type: u8,
request: u8,
value: u16,
index: u16,
buf: &mut [u8],
timeout: Duration
) -> Result<usize>
Reads data using a control transfer.
This function attempts to read data from the device using a control transfer and fills
buf
with any data received during the transfer. The function blocks up to the amount of
time specified by timeout
.
The parameters request_type
, request
, value
, and index
specify the fields of the
control transfer setup packet (bmRequestType
, bRequest
, wValue
, and wIndex
respectively). The values for each of these parameters shall be given in host-endian byte
order. The value for the request_type
parameter can be built with the helper function,
request_type(). The meaning of the other parameters depends on the
type of control request.
If the return value is Ok(n)
, then buf
is populated with n
bytes of data.
Errors
If this function encounters any form of error while fulfilling the transfer request, an error variant will be returned. If an error variant is returned, no bytes were read.
The errors returned by this function include:
InvalidParam
ifrequest_type
does not specify a read transfer.Timeout
if the transfer timed out.Pipe
if the control request was not supported by the device.NoDevice
if the device has been disconnected.Io
if the transfer encountered an I/O error.
pub fn write_control(
&self,
request_type: u8,
request: u8,
value: u16,
index: u16,
buf: &[u8],
timeout: Duration
) -> Result<usize>
[src]
&self,
request_type: u8,
request: u8,
value: u16,
index: u16,
buf: &[u8],
timeout: Duration
) -> Result<usize>
Writes data using a control transfer.
This function attempts to write the contents of buf
to the device using a control
transfer. The function blocks up to the amount of time specified by timeout
.
The parameters request_type
, request
, value
, and index
specify the fields of the
control transfer setup packet (bmRequestType
, bRequest
, wValue
, and wIndex
respectively). The values for each of these parameters shall be given in host-endian byte
order. The value for the request_type
parameter can be built with the helper function,
request_type(). The meaning of the other parameters depends on the
type of control request.
If the return value is Ok(n)
, then n
bytes of buf
were transfered.
Errors
If this function encounters any form of error while fulfilling the transfer request, an error variant will be returned. If an error variant is returned, no bytes were read.
The errors returned by this function include:
InvalidParam
ifrequest_type
does not specify a write transfer.Timeout
if the transfer timed out.Pipe
if the control request was not supported by the device.NoDevice
if the device has been disconnected.Io
if the transfer encountered an I/O error.
pub fn read_languages(&self, timeout: Duration) -> Result<Vec<Language>>
[src]
Reads the languages supported by the device's string descriptors.
This function returns a list of languages that can be used to read the device's string descriptors.
pub fn read_string_descriptor_ascii(&self, index: u8) -> Result<String>
[src]
Reads a ascii string descriptor from the device.
pub fn read_string_descriptor(
&self,
language: Language,
index: u8,
timeout: Duration
) -> Result<String>
[src]
&self,
language: Language,
index: u8,
timeout: Duration
) -> Result<String>
Reads a string descriptor from the device.
language
should be one of the languages returned from read_languages
.
pub fn read_manufacturer_string_ascii(
&self,
device: &DeviceDescriptor
) -> Result<String>
[src]
&self,
device: &DeviceDescriptor
) -> Result<String>
Reads the device's manufacturer string descriptor (ascii).
pub fn read_manufacturer_string(
&self,
language: Language,
device: &DeviceDescriptor,
timeout: Duration
) -> Result<String>
[src]
&self,
language: Language,
device: &DeviceDescriptor,
timeout: Duration
) -> Result<String>
Reads the device's manufacturer string descriptor.
pub fn read_product_string_ascii(
&self,
device: &DeviceDescriptor
) -> Result<String>
[src]
&self,
device: &DeviceDescriptor
) -> Result<String>
Reads the device's product string descriptor (ascii).
pub fn read_product_string(
&self,
language: Language,
device: &DeviceDescriptor,
timeout: Duration
) -> Result<String>
[src]
&self,
language: Language,
device: &DeviceDescriptor,
timeout: Duration
) -> Result<String>
Reads the device's product string descriptor.
pub fn read_serial_number_string_ascii(
&self,
device: &DeviceDescriptor
) -> Result<String>
[src]
&self,
device: &DeviceDescriptor
) -> Result<String>
Reads the device's serial number string descriptor (ascii).
pub fn read_serial_number_string(
&self,
language: Language,
device: &DeviceDescriptor,
timeout: Duration
) -> Result<String>
[src]
&self,
language: Language,
device: &DeviceDescriptor,
timeout: Duration
) -> Result<String>
Reads the device's serial number string descriptor.
pub fn read_configuration_string(
&self,
language: Language,
configuration: &ConfigDescriptor,
timeout: Duration
) -> Result<String>
[src]
&self,
language: Language,
configuration: &ConfigDescriptor,
timeout: Duration
) -> Result<String>
Reads the string descriptor for a configuration's description.
pub fn read_interface_string(
&self,
language: Language,
interface: &InterfaceDescriptor,
timeout: Duration
) -> Result<String>
[src]
&self,
language: Language,
interface: &InterfaceDescriptor,
timeout: Duration
) -> Result<String>
Reads the string descriptor for a interface's description.
Trait Implementations
impl<T: UsbContext> Sync for DeviceHandle<T>
[src]
impl<T: PartialEq + UsbContext> PartialEq<DeviceHandle<T>> for DeviceHandle<T>
[src]
fn eq(&self, other: &DeviceHandle<T>) -> bool
[src]
fn ne(&self, other: &DeviceHandle<T>) -> bool
[src]
impl<T: UsbContext> Drop for DeviceHandle<T>
[src]
impl<T: UsbContext> Send for DeviceHandle<T>
[src]
impl<T: Eq + UsbContext> Eq for DeviceHandle<T>
[src]
Auto Trait Implementations
impl<T> Unpin for DeviceHandle<T> where
T: Unpin,
T: Unpin,
impl<T> RefUnwindSafe for DeviceHandle<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> UnwindSafe for DeviceHandle<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,