Struct usbd_webusb::WebUsb

pub struct WebUsb<B: UsbBus> { /* fields omitted */ }

WebUSB class

Implementations

impl<B: UsbBus> WebUsb<B>

pub fn new(
    _alloc: &UsbBusAllocator<B>,
    scheme: u8,
    url: &'static str
) -> WebUsb<B>

Creates new WebUSB class with provided url and scheme.

pub fn vendor_code(&self) -> u8

Gets vendor code that is used for polling URL descriptor

pub fn set_vendor_code(mut self: Self, vendor_code: u8) -> Self

Sets vendor code that is used for polling URL descriptor

Trait Implementations

impl<B: UsbBus> UsbClass<B> for WebUsb<B>

fn get_bos_descriptors(&self, w: &mut BosWriter<'_, '_>) -> Result<()>

Called when a GET_DESCRIPTOR request is received for a BOS descriptor. When called, the implementation should write its blobs such as capability descriptors into writer. The BOS descriptor itself will be written by UsbDevice and shouldn't be written by classes.

fn control_in(&mut self, xfer: ControlIn<'_, '_, '_, B>)

Called when a control request is received with direction DeviceToHost.

pub fn get_configuration_descriptors(
    &self,
    writer: &mut DescriptorWriter<'_>
) -> Result<(), UsbError>

Called when a GET_DESCRIPTOR request is received for a configuration descriptor. When called, the implementation should write its interface, endpoint and any extra class descriptors into writer. The configuration descriptor itself will be written by UsbDevice and shouldn't be written by classes.

pub fn get_string(&self, index: StringIndex, lang_id: u16) -> Option<&str>

Gets a class-specific string descriptor.

pub fn reset(&mut self)

Called after a USB reset after the bus reset sequence is complete.

pub fn poll(&mut self)

Called whenever the UsbDevice is polled.

pub fn control_out(&mut self, xfer: ControlOut<'_, '_, '_, B>)

Called when a control request is received with direction HostToDevice.

pub fn endpoint_setup(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has received a SETUP packet. Implementing this shouldn't be necessary in most cases, but is provided for completeness' sake.

pub fn endpoint_out(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has received data (OUT packet).

pub fn endpoint_in_complete(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has completed transmitting data (IN packet).