ariel_os::reexports::embassy_usb::class::hid

Struct HidWriter

pub struct HidWriter<'d, D, const N: usize>
where D: Driver<'d>,
{ /* private fields */ }
Expand description

USB HID writer.

You can obtain a HidWriter using HidReaderWriter::split.

Implementations§

§

impl<'d, D, const N: usize> HidWriter<'d, D, N>
where D: Driver<'d>,

pub fn new( builder: &mut Builder<'d, D>, state: &'d mut State<'d>, config: Config<'d>, ) -> HidWriter<'d, D, N>

Creates a new HidWriter.

This will allocate one IN endpoint only, so the host won’t be able to send reports to us. If you need that, consider using HidReaderWriter::new instead.

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

pub async fn ready(&mut self)

Waits for the interrupt in endpoint to be enabled.

pub async fn write_serialize<IR>(&mut self, r: &IR) -> Result<(), EndpointError>
where IR: AsInputReport,

Available on crate feature usbd-hid only.

Writes an input report by serializing the given report structure.

pub async fn write(&mut self, report: &[u8]) -> Result<(), EndpointError>

Writes report to its interrupt endpoint.

Auto Trait Implementations§

§

impl<'d, D, const N: usize> Freeze for HidWriter<'d, D, N>
where <D as Driver<'d>>::EndpointIn: Freeze,

§

impl<'d, D, const N: usize> RefUnwindSafe for HidWriter<'d, D, N>
where <D as Driver<'d>>::EndpointIn: RefUnwindSafe,

§

impl<'d, D, const N: usize> Send for HidWriter<'d, D, N>
where <D as Driver<'d>>::EndpointIn: Send,

§

impl<'d, D, const N: usize> Sync for HidWriter<'d, D, N>
where <D as Driver<'d>>::EndpointIn: Sync,

§

impl<'d, D, const N: usize> Unpin for HidWriter<'d, D, N>
where <D as Driver<'d>>::EndpointIn: Unpin,

§

impl<'d, D, const N: usize> UnwindSafe for HidWriter<'d, D, N>
where <D as Driver<'d>>::EndpointIn: UnwindSafe,

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.

§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

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

§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V