embassy-usb

Crates

git

Versions

default

Flavors

Skip to main content

VendorClass

Struct VendorClass 

Source
pub struct VendorClass<'d, D: Driver<'d>> { /* private fields */ }
Expand description

Vendor-specific bulk USB class.

Implements bidirectional communication over one Bulk IN and one Bulk OUT endpoint.

Implementations§

Source§

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

Source

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

Creates a new VendorClass with the provided configuration.

Source

pub fn interface(&self) -> InterfaceNumber

Gets the interface number.

Source

pub fn max_packet_size(&self) -> u16

Gets the maximum packet size in bytes.

Source

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

Writes a single packet into the IN endpoint.

Source

pub async fn read_packet( &mut self, data: &mut [u8], ) -> Result<usize, EndpointError>

Reads a single packet from the OUT endpoint.

Source

pub async fn write_transfer( &mut self, data: &[u8], needs_zlp: bool, ) -> Result<(), EndpointDisabledError>

Writes a multi-packet transfer into the IN endpoint.

Source

pub async fn read_transfer( &mut self, data: &mut [u8], ) -> Result<usize, EndpointError>

Reads a multi-packet transfer from the OUT endpoint until a short packet is received.

Source

pub async fn wait_connection(&mut self)

Waits for the USB host to enable this interface.

Source

pub fn split(self) -> (Sender<'d, D>, Receiver<'d, D>)

Split the class into a sender and receiver for concurrent operation across tasks.

Auto Trait Implementations§

§

impl<'d, D> Forget for VendorClass<'d, D>

§

impl<'d, D> Freeze for VendorClass<'d, D>
where <D as Driver<'d>>::EndpointOut: Freeze, <D as Driver<'d>>::EndpointIn: Freeze,

§

impl<'d, D> Move for VendorClass<'d, D>

§

impl<'d, D> RefUnwindSafe for VendorClass<'d, D>

§

impl<'d, D> Send for VendorClass<'d, D>
where <D as Driver<'d>>::EndpointOut: Send, <D as Driver<'d>>::EndpointIn: Send,

§

impl<'d, D> Sync for VendorClass<'d, D>
where <D as Driver<'d>>::EndpointOut: Sync, <D as Driver<'d>>::EndpointIn: Sync,

§

impl<'d, D> Unpin for VendorClass<'d, D>
where <D as Driver<'d>>::EndpointOut: Unpin, <D as Driver<'d>>::EndpointIn: Unpin,

§

impl<'d, D> UnsafeUnpin for VendorClass<'d, D>
where <D as Driver<'d>>::EndpointOut: UnsafeUnpin, <D as Driver<'d>>::EndpointIn: UnsafeUnpin,

§

impl<'d, D> UnwindSafe for VendorClass<'d, D>
where <D as Driver<'d>>::EndpointOut: UnwindSafe, <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.

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

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

fn try_from(value: U) -> Result<T, !>

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.