Struct usb_device::endpoint::Endpoint [−][src]
Handle for a USB endpoint. The endpoint direction is constrained by the D
type argument, which
must be either In
or Out
.
Implementations
impl<B: UsbBus, D: EndpointDirection> Endpoint<'_, B, D>
[src]
pub fn address(&self) -> EndpointAddress
[src]
Gets the endpoint address including direction bit.
pub fn ep_type(&self) -> EndpointType
[src]
Gets the endpoint transfer type.
pub fn max_packet_size(&self) -> u16
[src]
Gets the maximum packet size for the endpoint.
pub fn interval(&self) -> u8
[src]
Gets the poll interval for interrupt endpoints.
pub fn stall(&self)
[src]
Sets the STALL condition for the endpoint.
pub fn unstall(&self)
[src]
Clears the STALL condition of the endpoint.
impl<B: UsbBus> Endpoint<'_, B, In>
[src]
pub fn write(&self, data: &[u8]) -> Result<usize>
[src]
Writes a single packet of data to the specified endpoint and returns number of bytes
actually written. The buffer must not be longer than the max_packet_size
specified when
allocating the endpoint.
Errors
Note: USB bus implementation errors are directly passed through, so be prepared to handle other errors as well.
WouldBlock
- The transmission buffer of the USB peripheral is full and the packet cannot be sent now. A peripheral may or may not support concurrent transmission of packets.BufferOverflow
- The data is longer than themax_packet_size
specified when allocating the endpoint. This is generally an error in the class implementation.
impl<B: UsbBus> Endpoint<'_, B, Out>
[src]
pub fn read(&self, data: &mut [u8]) -> Result<usize>
[src]
Reads a single packet of data from the specified endpoint and returns the actual length of
the packet. The buffer should be large enough to fit at least as many bytes as the
max_packet_size
specified when allocating the endpoint.
Errors
Note: USB bus implementation errors are directly passed through, so be prepared to handle other errors as well.
WouldBlock
- There is no packet to be read. Note that this is different from a received zero-length packet, which is valid and significant in USB. A zero-length packet will returnOk(0)
.BufferOverflow
- The received packet is too long to fit indata
. This is generally an error in the class implementation.
Auto Trait Implementations
impl<'a, B, D> Send for Endpoint<'a, B, D> where
D: Send,
D: Send,
impl<'a, B, D> Sync for Endpoint<'a, B, D> where
D: Sync,
D: Sync,
impl<'a, B, D> Unpin for Endpoint<'a, B, D> where
D: Unpin,
D: Unpin,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,