embassy-usb

Crates

git

Versions

default

Flavors

Skip to main content

Builder

Struct Builder 

Source
pub struct Builder<'d, D: Driver<'d>> { /* private fields */ }
Expand description

UsbDevice builder.

Implementations§

Source§

impl<'d, D: Driver<'d>> Builder<'d, D>

Source

pub fn new( driver: D, config: Config<'d>, config_descriptor_buf: &'d mut [u8], bos_descriptor_buf: &'d mut [u8], msos_descriptor_buf: &'d mut [u8], control_buf: &'d mut [u8], ) -> Self

Creates a builder for constructing a new UsbDevice.

control_buf is a buffer used for USB control request data. It should be sized large enough for the length of the largest control request (in or out) anticipated by any class added to the device.

Source

pub fn other_speed_config_descriptor(&mut self, buf: &'d mut [u8]) -> &mut Self

Sets a buffer for the OTHER_SPEED_CONFIGURATION descriptor.

When Config::max_speed is UsbDeviceSpeed::High, this buffer will be populated with the Full-Speed configuration descriptor and served in response to GET_DESCRIPTOR for OTHER_SPEED_CONFIGURATION.

The buffer must be at least as large as the configuration descriptor.

Source

pub fn build(self) -> UsbDevice<'d, D>

Creates the UsbDevice instance with the configuration in this builder.

Source

pub fn control_buf_len(&self) -> usize

Returns the size of the control request data buffer. Can be used by classes to validate the buffer is large enough for their needs.

Source

pub fn max_speed(&self) -> UsbDeviceSpeed

Returns the fastest speed the configuration descriptor is built for, so that classes can size their endpoints for it.

Source

pub fn function( &mut self, class: u8, subclass: u8, protocol: u8, ) -> FunctionBuilder<'_, 'd, D>

Add an USB function.

If Config::composite_with_iads is set, this will add an IAD descriptor with the given class/subclass/protocol, associating all the child interfaces.

If it’s not set, no IAD descriptor is added.

Source

pub fn handler(&mut self, handler: &'d mut dyn Handler)

Add a raw Handler.

The handler is called on USB bus events and for every control request that reaches application handlers.

Panics if max_handler_count is exhausted. Use try_handler for a fallible version.

Source

pub fn try_handler( &mut self, handler: &'d mut dyn Handler, ) -> Result<(), HandlerFull>

Fallible variant of handler.

Source

pub fn interface_handler(&mut self, handler: &'d mut dyn InterfaceHandler)

Add an InterfaceHandler.

Unlike handler, the handler only receives control requests addressed to interfaces it owns.

Panics if max_handler_count is exhausted. Use try_interface_handler for a fallible version.

Source

pub fn try_interface_handler( &mut self, handler: &'d mut dyn InterfaceHandler, ) -> Result<(), HandlerFull>

Fallible variant of interface_handler.

Source

pub fn string(&mut self) -> StringIndex

Allocates a new string index.

Source

pub fn msos_descriptor(&mut self, windows_version: u32, vendor_code: u8)

Add an MS OS 2.0 Descriptor Set.

Panics if called more than once.

Source

pub fn msos_feature<T: DeviceLevelDescriptor>(&mut self, desc: T)

Add an MS OS 2.0 Device Level Feature Descriptor.

Source

pub fn msos_writer(&mut self) -> &mut MsOsDescriptorWriter<'d>

Gets the underlying MsOsDescriptorWriter to allow adding subsets and features for classes that do not add their own.

Auto Trait Implementations§

§

impl<'d, D> !RefUnwindSafe for Builder<'d, D>

§

impl<'d, D> !Send for Builder<'d, D>

§

impl<'d, D> !Sync for Builder<'d, D>

§

impl<'d, D> !UnwindSafe for Builder<'d, D>

§

impl<'d, D> Forget for Builder<'d, D>

§

impl<'d, D> Freeze for Builder<'d, D>
where D: Freeze,

§

impl<'d, D> Move for Builder<'d, D>

§

impl<'d, D> Unpin for Builder<'d, D>
where D: Unpin,

§

impl<'d, D> UnsafeUnpin for Builder<'d, D>
where D: UnsafeUnpin,

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> 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.