Struct embassy_stm32::usart::RingBufferedUartRx
source ยท pub struct RingBufferedUartRx<'d> { /* private fields */ }
Expand description
Rx-only Ring-buffered UART Driver
Created with UartRx::into_ring_buffered
Implementationsยง
sourceยงimpl<'d> RingBufferedUartRx<'d>
impl<'d> RingBufferedUartRx<'d>
sourcepub fn start(&mut self) -> Result<(), Error>
pub fn start(&mut self) -> Result<(), Error>
Clear the ring buffer and start receiving in the background
sourcepub fn set_config(&mut self, config: &Config) -> Result<(), ConfigError>
pub fn set_config(&mut self, config: &Config) -> Result<(), ConfigError>
Reconfigure the driver
sourcepub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
Read bytes that are readily available in the ring buffer. If no bytes are currently available in the buffer the call waits until the some bytes are available (at least one byte and at most half the buffer size)
Background receive is started if start()
has not been previously called.
Receive in the background is terminated if an error is returned.
It must then manually be started again by calling start()
or by re-calling read()
.
Trait Implementationsยง
sourceยงimpl Drop for RingBufferedUartRx<'_>
impl Drop for RingBufferedUartRx<'_>
sourceยงimpl ErrorType for RingBufferedUartRx<'_>
impl ErrorType for RingBufferedUartRx<'_>
sourceยงimpl Read for RingBufferedUartRx<'_>
impl Read for RingBufferedUartRx<'_>
sourceยงasync fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>
async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>
Read some bytes from this source into the specified buffer, returning how many bytes were read. Read more
sourceยงasync fn read_exact(
&mut self,
buf: &mut [u8],
) -> Result<(), ReadExactError<Self::Error>>
async fn read_exact( &mut self, buf: &mut [u8], ) -> Result<(), ReadExactError<Self::Error>>
Read the exact number of bytes required to fill
buf
. Read moresourceยงimpl<'d> SetConfig for RingBufferedUartRx<'d>
impl<'d> SetConfig for RingBufferedUartRx<'d>
sourceยงtype ConfigError = ConfigError
type ConfigError = ConfigError
The error type that can occur if
set_config
fails.sourceยงfn set_config(&mut self, config: &Self::Config) -> Result<(), Self::ConfigError>
fn set_config(&mut self, config: &Self::Config) -> Result<(), Self::ConfigError>
Set the configuration of the driver.
Auto Trait Implementationsยง
impl<'d> Freeze for RingBufferedUartRx<'d>
impl<'d> !RefUnwindSafe for RingBufferedUartRx<'d>
impl<'d> Send for RingBufferedUartRx<'d>
impl<'d> Sync for RingBufferedUartRx<'d>
impl<'d> Unpin for RingBufferedUartRx<'d>
impl<'d> !UnwindSafe for RingBufferedUartRx<'d>
Blanket Implementationsยง
sourceยงimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
sourceยงfn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more