Struct Class 

pub struct Class {
    pub class: u8,
    pub sub_class: u8,
    pub protocol: u8,
}

USB interface class.

Fields

class: u8

Class code.

sub_class: u8

Subclass code.

protocol: u8

Protocol code.

Implementations

impl Class

pub const VENDOR_SPECIFIC: u8 = 0xff

Vendor specific class code.

pub const fn new(class: u8, sub_class: u8, protocol: u8) -> Self

Creates a new USB device or interface class.

pub const fn vendor_specific(sub_class: u8, protocol: u8) -> Self

Creates a new USB device or interface class with vendor-specific class code.

Examples found in repository

examples/common.rs (line 9)

pub const CLASS: Class = Class::vendor_specific(22, 3);

examples/device.rs (line 16)

const DEVICE_CLASS: Class = Class::vendor_specific(0xff, 0);

examples/simple_host.rs (line 10)

async fn main() -> std::io::Result<()> {
    let class = Class::vendor_specific(0x01, 0);

    // Find and open the USB device.
    let dev_info = nusb::list_devices()
        .await?
        .find(|d| d.vendor_id() == 0x1209 && d.product_id() == 0x0001)
        .expect("device not found");
    let iface = find_interface(&dev_info, class)?;
    let dev = dev_info.open().await?;

    // Connect and exchange packets.
    let (tx, mut rx) = connect(dev, iface, b"hello").await?;
    tx.send(b"ping"[..].into()).await?;
    let reply = rx.recv().await?;
    println!("received: {:?}", reply);
    Ok(())
}

examples/simple_device.rs (line 13)

async fn main() -> std::io::Result<()> {
    let class = Class::vendor_specific(0x01, 0);

    // Create a USB gadget with a UPC function.
    let (mut upc, hnd) =
        UpcFunction::new(InterfaceId::new(class).with_guid(uuid!("3bf77270-42d2-42c6-a475-490227a9cc89")));
    upc.set_info(b"my device".to_vec()).await;

    let udc = default_udc().expect("no UDC available");
    let gadget = Gadget::new(class.into(), Id::new(0x1209, 0x0001), Strings::new("mfr", "product", "serial"))
        .with_config(Config::new("config").with_function(hnd))
        .with_os_descriptor(OsDescriptor::microsoft());
    let _reg = gadget.bind(&udc).expect("cannot bind to UDC");

    // Accept a connection and exchange packets.
    let (tx, mut rx) = upc.accept().await?;
    if let Some(data) = rx.recv().await? {
        println!("received: {:?}", data);
        tx.send(b"pong"[..].into()).await?;
    }

    // Allow USB transport to flush before teardown.
    tokio::time::sleep(Duration::from_secs(1)).await;
    Ok(())
}

Trait Implementations

impl Clone for Class

fn clone(&self) -> Class

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Class

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

Formats the value using the given formatter.

impl From<Class> for Class

Available on crate feature device only.

fn from(_: Class) -> Self

Converts to this type from the input type.

impl From<Class> for InterfaceId

fn from(class: Class) -> Self

Converts to this type from the input type.

impl Hash for Class

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Class

fn cmp(&self, other: &Class) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Class

fn eq(&self, other: &Class) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Class

fn partial_cmp(&self, other: &Class) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Class

impl Eq for Class

impl StructuralPartialEq for Class