embassy-usb

Crates

git

Versions

default

Flavors

Skip to main content

Config

Struct Config 

Source
pub struct Config<'d> {
    pub subclass: u8,
    pub protocol: u8,
    pub interface_name: Option<&'d str>,
    pub msos_interface_guids: Option<&'d [&'d str]>,
    pub webusb: bool,
    pub webusb_landing_url: Option<Url<'d>>,
    pub webusb_vendor_code: u8,
    pub out_endpoint_options: EndpointOptions,
    pub in_endpoint_options: EndpointOptions,
}
Expand description

Configuration for the Vendor class.

Fields§

§subclass: u8

Vendor subclass code (default: 0x00).

§protocol: u8

Vendor protocol code (default: 0x00).

§interface_name: Option<&'d str>

Optional interface string description.

§msos_interface_guids: Option<&'d [&'d str]>

Optional Microsoft OS 2.0 WinUSB Device Interface GUIDs.

When specified, Microsoft OS 2.0 descriptors are automatically generated with Compatible ID “WINUSB” and the provided GUIDs. Windows 8.1+ will automatically load winusb.sys without an INF file or manual driver installation.

Example: &["{CDB3B5AD-293B-4663-AA36-1AAE46463776}"]

§webusb: bool

Whether WebUSB platform capability should be registered.

§webusb_landing_url: Option<Url<'d>>

Optional WebUSB URL landing page.

§webusb_vendor_code: u8

WebUSB vendor request code (default: 0x01).

§out_endpoint_options: EndpointOptions

Options for the bulk OUT endpoint, which receives the data the host sends.

§in_endpoint_options: EndpointOptions

Options for the bulk IN endpoint, which sends data to the host.

Implementations§

Source§

impl<'d> Config<'d>

Source

pub const fn new() -> Self

Create a new Config with default settings.

Source

pub const fn with_interface_name(self, name: &'d str) -> Self

Set the interface string description.

Source

pub const fn with_winusb(self, guids: &'d [&'d str]) -> Self

Set Microsoft OS 2.0 WinUSB device interface GUIDs.

Source

pub const fn with_webusb( self, landing_url: Option<Url<'d>>, vendor_code: u8, ) -> Self

Enable WebUSB platform capability with an optional landing URL and vendor request code.

Source

pub const fn with_subclass_protocol(self, subclass: u8, protocol: u8) -> Self

Set custom subclass and protocol codes.

Trait Implementations§

Source§

impl<'d> Clone for Config<'d>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'d> Debug for Config<'d>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'d> Default for Config<'d>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'d> Eq for Config<'d>

Source§

impl<'d> Format for Config<'d>
where Option<&'d str>: Format, Option<&'d [&'d str]>: Format, Option<Url<'d>>: Format, EndpointOptions: Format,

Source§

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.
Source§

impl<'d> PartialEq for Config<'d>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'d> StructuralPartialEq for Config<'d>

Auto Trait Implementations§

§

impl<'d> Forget for Config<'d>

§

impl<'d> Freeze for Config<'d>

§

impl<'d> Move for Config<'d>

§

impl<'d> RefUnwindSafe for Config<'d>

§

impl<'d> Send for Config<'d>

§

impl<'d> Sync for Config<'d>

§

impl<'d> Unpin for Config<'d>

§

impl<'d> UnsafeUnpin for Config<'d>

§

impl<'d> UnwindSafe for Config<'d>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.