Embassy

embassy_usb::class::hid

Struct Config

pub struct Config<'d> {
    pub report_descriptor: &'d [u8],
    pub request_handler: Option<&'d mut dyn RequestHandler>,
    pub poll_ms: u8,
    pub max_packet_size: u16,
}

Expand description

Configuration for the HID class.

Fields§

§report_descriptor: &'d [u8]

HID report descriptor.

§request_handler: Option<&'d mut dyn RequestHandler>

Handler for control requests.

§poll_ms: u8

Configures how frequently the host should poll for reading/writing HID reports.

A lower value means better throughput & latency, at the expense of CPU on the device & bandwidth on the bus. A value of 10 is reasonable for high performance uses, and a value of 255 is good for best-effort usecases.

§max_packet_size: u16

Max packet size for both the IN and OUT endpoints.

Auto Trait Implementations§

impl<'d> Freeze 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> !UnwindSafe for Config<'d>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.