Struct RingBufferedUartRx

pub struct RingBufferedUartRx<'d> { /* private fields */ }

Rx-only Ring-buffered UART Driver

Created with UartRx::into_ring_buffered

Implementations

impl<'d> RingBufferedUartRx<'d>

pub fn set_config(&mut self, config: &Config) -> Result<(), ConfigError>

Reconfigure the driver

pub fn start_uart(&mut self)

Configure and start the DMA backed UART receiver

Note: This is also done automatically by [read()] if required.

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

impl Drop for RingBufferedUartRx<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl ErrorType for RingBufferedUartRx<'_>

type Error = Error

Error type of all the IO operations on this type.

impl Read for RingBufferedUartRx<'_>

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.

async fn read_exact( &mut self, buf: &mut [u8], ) -> Result<(), ReadExactError<Self::Error>>

Read the exact number of bytes required to fill buf.

impl ReadReady for RingBufferedUartRx<'_>

fn read_ready(&mut self) -> Result<bool, Self::Error>

Get whether the reader is ready for immediately reading.

impl<'d> SetConfig for RingBufferedUartRx<'d>

type Config = Config

The configuration type used by this driver.

type ConfigError = ConfigError

The error type that can occur if set_config fails.

fn set_config(&mut self, config: &Self::Config) -> Result<(), Self::ConfigError>

Set the configuration of the driver.