Struct BufferedUart

pub struct BufferedUart { /* private fields */ }

Buffered UART driver.

Implementations

impl BufferedUart

pub fn new<'d, 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, ) -> Self

Create a buffered UART instance.

pub fn new_with_rtscts<'d, 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, ) -> Self

Create a buffered UART instance with flow control.

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 blocking execution until done.

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

Read from UART RX buffer blocking execution until done.

pub fn busy(&self) -> bool

Check if UART is busy transmitting.

pub async fn send_break(&mut self, bits: u32)

Wait until TX is empty and send break condition.

pub fn set_baudrate<'d>(&mut self, baudrate: u32)

sets baudrate on runtime

pub fn split(self) -> (BufferedUartTx, BufferedUartRx)

Split into separate RX and TX handles.

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

Split the Uart into a transmitter and receiver by mutable reference, which is particularly useful when having two tasks correlating to transmitting and receiving.

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, Error<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 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, char: 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.

impl Write<u8> for BufferedUart

type Error = Error

The type of error that can occur when writing

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

Writes a slice, blocking until everything has been written

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

Block until the serial interface has sent all buffered words

impl Read<u8> for BufferedUart

type Error = Error

Read error

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

Reads a single word from the serial interface