Struct UartRx

pub struct UartRx<'d, M, T = AnyUart> { /* private fields */ }

UART (Receive)

Implementations

impl<'d, M, T> UartRx<'d, M, T>

where T: Instance, M: Mode,

pub fn with_cts( self, cts: impl Peripheral<P = impl PeripheralInput> + 'd, ) -> Self

Configure CTS pin

pub fn apply_config(&mut self, config: &Config) -> Result<(), Error>

Change the configuration.

Note that this also changes the configuration of the TX half.

pub fn read_bytes(&mut self, buf: &mut [u8]) -> Result<(), Error>

Fill a buffer with received bytes

pub fn read_byte(&mut self) -> Result<u8, Error>

Read a byte from the UART

pub fn drain_fifo(&mut self, buf: &mut [u8]) -> usize

Read all available bytes from the RX FIFO into the provided buffer and returns the number of read bytes. Never blocks

impl<'d> UartRx<'d, Blocking>

pub fn new( uart: impl Peripheral<P = impl Instance> + 'd, rx: impl Peripheral<P = impl PeripheralInput> + 'd, ) -> Result<Self, Error>

Create a new UART RX instance in Blocking mode.

pub fn new_with_config( uart: impl Peripheral<P = impl Instance> + 'd, config: Config, rx: impl Peripheral<P = impl PeripheralInput> + 'd, ) -> Result<Self, Error>

Create a new UART RX instance with configuration options in Blocking mode.

impl<'d, T> UartRx<'d, Blocking, T>

where T: Instance,

pub fn new_typed( uart: impl Peripheral<P = T> + 'd, rx: impl Peripheral<P = impl PeripheralInput> + 'd, ) -> Result<Self, Error>

Create a new UART RX instance in Blocking mode.

pub fn new_with_config_typed( uart: impl Peripheral<P = T> + 'd, config: Config, rx: impl Peripheral<P = impl PeripheralInput> + 'd, ) -> Result<Self, Error>

Create a new UART RX instance with configuration options in Blocking mode.

pub fn into_async(self) -> UartRx<'d, Async, T>

Reconfigures the driver to operate in Async mode.

impl<'d, T> UartRx<'d, Async, T>

where T: Instance,

pub fn into_blocking(self) -> UartRx<'d, Blocking, T>

Reconfigures the driver to operate in Blocking mode.

impl<T> UartRx<'_, Async, T>

where T: Instance,

pub async fn read_async(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Read async to buffer slice buf. Waits until at least one byte is in the Rx FiFo and one of the following interrupts occurs:

• RXFIFO_FULL
• RXFIFO_OVF
• AT_CMD_CHAR_DET (only if set_at_cmd was called)
• RXFIFO_TOUT (only if `set_rx_timeout was called)

The interrupts in question are enabled during the body of this function. The method immediately returns when the interrupt has already occurred before calling this method (e.g. status bit set, but interrupt not enabled)

Params

• buf buffer slice to write the bytes into

Ok

When successful, returns the number of bytes written to buf. This method will never return Ok(0)

Trait Implementations

impl<T, M> ErrorType for UartRx<'_, M, T>

type Error = Error

Error type

impl<T, M> ErrorType for UartRx<'_, M, T>

type Error = Error

Error type of all the IO operations on this type.

impl<T> Read for UartRx<'_, Async, T>

where T: Instance,

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

In contrast to the documentation of embedded_io_async::Read, this method blocks until an uart interrupt occurs. See UartRx::read_async for more details.

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

Read the exact number of bytes required to fill buf.

impl<T, M> Read for UartRx<'_, M, T>

where T: Instance, M: Mode,

fn read(&mut self) -> Result<u8, Self::Error>

Reads a single word from the serial interface

impl<T, M> Read for UartRx<'_, M, T>

where T: Instance, M: Mode,

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.

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

Read the exact number of bytes required to fill buf.

impl<T, M> ReadReady for UartRx<'_, M, T>

where T: Instance, M: Mode,

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

Get whether the reader is ready for immediately reading.

impl<M, T> SetConfig for UartRx<'_, M, T>

where T: Instance, M: Mode,

type Config = Config

The configuration type used by this driver.

type ConfigError = Error

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.

impl<T, M> Read<u8> for UartRx<'_, M, T>

where T: Instance, M: Mode,

type Error = Error

Read error

fn read(&mut self) -> Result<u8, Self::Error>

Reads a single word from the serial interface