embassy-usb-host

Crates

git

Versions

default

Flavors

HIDDescriptor

Struct HIDDescriptor 

Source
pub struct HIDDescriptor {
    pub bcd_hid: u16,
    pub country_code: u8,
    pub num_descriptors: u8,
    pub descriptor_type0: u8,
    pub descriptor_length0: u16,
}
Expand description

USB HID class descriptor.

This descriptor identifies subordinate class descriptors. (USB HID 1.11 §6.2.1)

Fields§

§bcd_hid: u16

USB HID specification version that the class descriptors comply to.

§country_code: u8

Country code.

For country code 0, the hardware is not localized.

Keyboards may use this field to identify the language of the key caps.

§num_descriptors: u8

Number of class descriptors.

§descriptor_type0: u8

Type of the class descriptor 0.

§descriptor_length0: u16

Length of the class descriptor 0.

Implementations§

Source§

impl HIDDescriptor

Source

pub const SUPPORTED_DESCRIPTORS: u8 = 1u8

Maximum number of class descriptors that we support (at most 83).

Trait Implementations§

Source§

impl Clone for HIDDescriptor

Source§

fn clone(&self) -> HIDDescriptor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HIDDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Format for HIDDescriptor

Source§

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

Writes the defmt representation of self to fmt.
Source§

impl PartialEq for HIDDescriptor

Source§

fn eq(&self, other: &HIDDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl USBDescriptor for HIDDescriptor

Source§

const BUF_SIZE: usize = 9usize

Size of the byte buffer. Read more
Source§

const DESC_TYPE: u8 = 33u8

Descriptor type. Read more
Source§

type Error = DescriptorError

Source§

fn try_from_bytes(bytes: &[u8]) -> Result<Self, Self::Error>

Source§

const DESC_SUBTYPE: Option<u8> = None

Descriptor subtype. Read more
Source§

impl VariableSizeDescriptor for HIDDescriptor

Source§

fn match_bytes_len(bytes: &[u8]) -> bool

Matches length with the number of class descriptors.

Source§

const MIN_LEN: u8 = 9u8

Minimum length of the descriptor. Read more
Source§

const MAX_LEN: u8 = 89u8

Maximum length of the descriptor. Read more
Source§

fn match_bytes(bytes: &[u8]) -> Result<(), DescriptorError>

Matches bytes with this descriptor. Read more
Source§

fn prepare_bytes(bytes: &mut [u8], len: u8) -> Result<(), DescriptorError>
where Self: WritableDescriptor,

Prepares bytes to receive descriptor data. Read more
Source§

impl WritableDescriptor for HIDDescriptor

Source§

fn write_to_bytes(&self, bytes: &mut [u8]) -> Result<usize, Self::Error>

Writes this descriptor to the start of the byte buffer bytes. Read more
Source§

fn write_to_bytes_partial(&self, bytes: &mut [u8]) -> Result<usize, Self::Error>

Writes this descriptor to the start of the byte buffer bytes. Read more
Source§

impl Copy for HIDDescriptor

Source§

impl Eq for HIDDescriptor

Source§

impl StructuralPartialEq for HIDDescriptor

Auto Trait Implementations§

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 = Infallible

The type returned in the event of a conversion error.
Source§

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

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.