embassy-usb

Crates

git

Versions

default

Flavors

Skip to main content

Config

Struct Config 

Source
pub struct Config<'d> {
    pub interface_name: Option<&'d str>,
    pub msos_descriptor: bool,
    pub interrupt_poll_ms: u8,
    pub interrupt_max_packet_size: u16,
    pub out_endpoint_options: EndpointOptions,
    pub in_endpoint_options: EndpointOptions,
}
Expand description

Configuration for the MTP device class.

Fields§

§interface_name: Option<&'d str>

Optional interface string descriptor. Defaults to Some("MTP").

§msos_descriptor: bool

Whether to emit an MS OS 2.0 Compatible ID ("MTP") descriptor so Windows binds its native MTP/WPD driver automatically.

When enabled, the Builder must be supplied with a non-empty msos_descriptor_buf.

§interrupt_poll_ms: u8

Polling interval in ms for the Interrupt-IN event endpoint. Defaults to 16.

§interrupt_max_packet_size: u16

Max packet size for the Interrupt-IN event endpoint (must be >= 24). Defaults to 64.

§out_endpoint_options: EndpointOptions

Options for the Bulk-OUT endpoint.

§in_endpoint_options: EndpointOptions

Options for the Bulk-IN endpoint.

Implementations§

Source§

impl<'d> Config<'d>

Source

pub const fn new() -> Self

Creates a default MTP configuration.

Source

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

Sets the interface string descriptor name.

Source

pub const fn with_msos(self, enabled: bool) -> Self

Enables or disables emitting the MS OS 2.0 "MTP" compatible ID descriptor.

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> Copy for Config<'d>

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> Format for Config<'d>

Source§

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

Writes the defmt representation of self to fmt.

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.