Struct BufferedUartRx

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

Rx-only buffered UART.

Can be obtained from BufferedUart::split, or can be constructed independently, if you do not need the transmitting half of the driver.

Implementations

impl<'d> BufferedUartRx<'d>

pub fn new<T: Instance>( uart: Peri<'d, T>, rx: Peri<'d, impl RxPin<T>>, _irq: impl Binding<T::Interrupt, BufferedInterruptHandler<T>>, rx_buffer: &'d mut [u8], config: Config, ) -> Result<Self, ConfigError>

Create a new rx-only buffered UART with no hardware flow control.

Useful if you only want Uart Rx. It saves 1 pin.

pub fn new_with_rts<T: Instance>( uart: Peri<'d, T>, rx: Peri<'d, impl RxPin<T>>, rts: Peri<'d, impl RtsPin<T>>, _irq: impl Binding<T::Interrupt, BufferedInterruptHandler<T>>, rx_buffer: &'d mut [u8], config: Config, ) -> Result<Self, ConfigError>

Create a new rx-only buffered UART with a request-to-send pin

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

Reconfigure the driver

pub fn set_baudrate(&mut self, baudrate: u32) -> Result<(), ConfigError>

Set baudrate

pub fn blocking_read(&mut self, buffer: &mut [u8]) -> Result<usize, Error>

Read from UART RX buffer, blocking execution until done.

Trait Implementations

impl BufRead for BufferedUartRx<'_>

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

Return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tell this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to fill_buf.

impl Drop for BufferedUartRx<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl ErrorType for BufferedUartRx<'_>

type Error = Error

Error type of all the IO operations on this type.

impl ErrorType for BufferedUartRx<'_>

type Error = Error

Error type

impl Read for BufferedUartRx<'_>

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 Read for BufferedUartRx<'_>

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 Read for BufferedUartRx<'_>

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

Reads a single word from the serial interface

impl ReadReady for BufferedUartRx<'_>

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

Get whether the reader is ready for immediately reading.

impl SetConfig for BufferedUartRx<'_>

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.