Struct rusb::HotplugBuilder

pub struct HotplugBuilder { /* fields omitted */ }

Builds hotplug Registration with custom configuration values.

Implementations

impl HotplugBuilder

pub fn new() -> Self

Returns a new builder with the no filter Devices can optionally be filtered by HotplugBuilder::vendor_id and HotplugBuilder::product_id

Registration is done by by calling register.

pub fn vendor_id(&mut self, vendor_id: u16) -> &mut Self

Devices can optionally be filtered by vendor

pub fn product_id(&mut self, product_id: u16) -> &mut Self

Devices can optionally be filtered by product id

pub fn class(&mut self, class: u8) -> &mut Self

Devices can optionally be filtered by class

pub fn enumerate(&mut self, enumerate: bool) -> &mut Self

If enumerate is true, then devices that are already connected will cause your callback’s Hotplug::device_arrived method to be called for them.

pub fn register<U: UsbContext, T: Borrow<U>>(
    self,
    context: T,
    callback: Box<dyn Hotplug<U>>
) -> Result<Registration<U>>

Register a callback to be called on hotplug events. The callback’s Hotplug::device_arrived method is called when a new device is added to the bus, and Hotplug::device_left is called when it is removed.

The callback will remain registered until the returned Registration is dropped, which can be done explicitly with Context::unregister_callback.

When handling a Hotplug::device_arrived event it is considered safe to call any rusb function that takes a Device. It also safe to open a device and submit asynchronous transfers. However, most other functions that take a DeviceHandle are not safe to call. Examples of such functions are any of the synchronous API functions or the blocking functions that retrieve various USB descriptors. These functions must be used outside of the context of the Hotplug functions.

Trait Implementations

impl Clone for HotplugBuilder

fn clone(&self) -> HotplugBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HotplugBuilder

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

Formats the value using the given formatter.

impl Default for HotplugBuilder

fn default() -> HotplugBuilder

Returns the “default value” for a type.

impl Copy for HotplugBuilder