Embassy
embassy-usb

Crates

git

Versions

default

Flavors

Struct embassy_usb::UsbDevice

source ·
pub struct UsbDevice<'d, D: Driver<'d>> { /* private fields */ }
Expand description

Main struct for the USB device stack.

Implementations§

source§

impl<'d, D: Driver<'d>> UsbDevice<'d, D>

source

pub fn buffer_usage(&self) -> UsbBufferReport

Returns a report of the consumed buffers

Useful for tuning buffer sizes for actual usage

source

pub async fn run(&mut self) -> !

Runs the UsbDevice forever.

This future may leave the bus in an invalid state if it is dropped. After dropping the future, UsbDevice::disable() should be called before calling any other UsbDevice methods to fully reset the peripheral.

source

pub async fn run_until_suspend(&mut self)

Runs the UsbDevice until the bus is suspended.

This future may leave the bus in an invalid state if it is dropped. After dropping the future, UsbDevice::disable() should be called before calling any other UsbDevice methods to fully reset the peripheral.

source

pub async fn disable(&mut self)

Disables the USB peripheral.

source

pub async fn wait_resume(&mut self)

Waits for a resume condition on the USB bus.

This future is cancel-safe.

source

pub async fn remote_wakeup(&mut self) -> Result<(), RemoteWakeupError>

Initiates a device remote wakeup on the USB bus.

If the bus is not suspended or remote wakeup is not enabled, an error will be returned.

This future may leave the bus in an inconsistent state if dropped. After dropping the future, UsbDevice::disable() should be called before calling any other UsbDevice methods to fully reset the peripheral.

Auto Trait Implementations§

§

impl<'d, D> Freeze for UsbDevice<'d, D>
where <D as Driver<'d>>::Bus: Freeze, <D as Driver<'d>>::ControlPipe: Freeze,

§

impl<'d, D> !RefUnwindSafe for UsbDevice<'d, D>

§

impl<'d, D> !Send for UsbDevice<'d, D>

§

impl<'d, D> !Sync for UsbDevice<'d, D>

§

impl<'d, D> Unpin for UsbDevice<'d, D>
where <D as Driver<'d>>::Bus: Unpin, <D as Driver<'d>>::ControlPipe: Unpin,

§

impl<'d, D> !UnwindSafe for UsbDevice<'d, D>

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.

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>,

§

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>,

§

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.