Struct BufferedUart

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

Bidirectional buffered UART which acts as a combination of BufferedUartTx and BufferedUartRx.

Implementations

impl<'d> BufferedUart<'d>

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

Create a new bidirectional buffered UART.

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

Create a new bidirectional buffered UART with request-to-send and clear-to-send pins

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_write(&mut self, buffer: &[u8]) -> Result<usize, Error>

Write to UART TX buffer, blocking execution until done.

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

Flush UART TX buffer, blocking execution until done.

pub fn busy(&self) -> bool

Check if UART is busy.

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

Read from UART RX buffer, blocking execution until done.

pub fn send_break(&mut self)

Send break character.

pub fn split(self) -> (BufferedUartTx<'d>, BufferedUartRx<'d>)

Split into separate RX and TX handles.

pub fn split_ref(&mut self) -> (BufferedUartTx<'_>, BufferedUartRx<'_>)

Split into separate RX and TX handles.

Trait Implementations

impl BufRead for BufferedUart<'_>

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 ErrorType for BufferedUart<'_>

type Error = Error

Error type of all the IO operations on this type.

impl ErrorType for BufferedUart<'_>

type Error = Error

Error type

impl Read for BufferedUart<'_>

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 BufferedUart<'_>

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 BufferedUart<'_>

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

Reads a single word from the serial interface

impl ReadReady for BufferedUart<'_>

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

Get whether the reader is ready for immediately reading.

impl SetConfig for BufferedUart<'_>

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.

impl Write for BufferedUart<'_>

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

Write a buffer into this writer, returning how many bytes were written.

async fn flush(&mut self) -> Result<(), Self::Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Write an entire buffer into this writer.

impl Write for BufferedUart<'_>

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

Write a buffer into this writer, returning how many bytes were written.

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

Flush this output stream, blocking until all intermediately buffered contents reach their destination.

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

Write an entire buffer into this writer.

fn write_fmt( &mut self, fmt: Arguments<'_>, ) -> Result<(), WriteFmtError<Self::Error>>

Write a formatted string into this writer, returning any error encountered.

impl Write for BufferedUart<'_>

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

Writes a single word to the serial interface.

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

Ensures that none of the previously written words are still buffered.