Struct usbd_human_interface_device::hid_class::UsbHidClass

pub struct UsbHidClass<B, I> { /* private fields */ }

USB Human Interface Device class

Implementations

impl<'a, B, InterfaceList: InterfaceHList<'a>> UsbHidClass<B, InterfaceList>

pub fn interface<T, Index>(&self) -> &Twhere InterfaceList: Selector<T, Index>,

pub fn interfaces(&'a self) -> InterfaceList::Output

Trait Implementations

impl<B: Clone, I: Clone> Clone for UsbHidClass<B, I>

fn clone(&self) -> UsbHidClass<B, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug, I: Debug> Debug for UsbHidClass<B, I>

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

Formats the value using the given formatter.

impl<B: PartialEq, I: PartialEq> PartialEq<UsbHidClass<B, I>> for UsbHidClass<B, I>

fn eq(&self, other: &UsbHidClass<B, I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, B, I> UsbClass<B> for UsbHidClass<B, I>where B: UsbBus, I: InterfaceHList<'a>,

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

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.

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

Gets a class-specific string descriptor.

fn reset(&mut self)

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

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

Called when a control request is received with direction HostToDevice.

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

Called when a control request is received with direction DeviceToHost.

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

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 poll(&mut self)

Called whenever the UsbDevice is polled.

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.

fn endpoint_out(&mut self, addr: EndpointAddress)

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

fn endpoint_in_complete(&mut self, addr: EndpointAddress)

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

impl<B: Copy, I: Copy> Copy for UsbHidClass<B, I>

impl<B: Eq, I: Eq> Eq for UsbHidClass<B, I>

impl<B, I> StructuralEq for UsbHidClass<B, I>

impl<B, I> StructuralPartialEq for UsbHidClass<B, I>