Struct BufferedUarte

pub struct BufferedUarte<'d, U: UarteInstance, T: TimerInstance> { /* private fields */ }

Buffered UARTE driver.

Implementations

impl<'d, U: UarteInstance, T: TimerInstance> BufferedUarte<'d, U, T>

pub fn new( uarte: impl Peripheral<P = U> + 'd, timer: impl Peripheral<P = T> + 'd, ppi_ch1: impl Peripheral<P = impl ConfigurableChannel> + 'd, ppi_ch2: impl Peripheral<P = impl ConfigurableChannel> + 'd, ppi_group: impl Peripheral<P = impl Group> + 'd, _irq: impl Binding<U::Interrupt, InterruptHandler<U>> + 'd, rxd: impl Peripheral<P = impl GpioPin> + 'd, txd: impl Peripheral<P = impl GpioPin> + 'd, config: Config, rx_buffer: &'d mut [u8], tx_buffer: &'d mut [u8], ) -> Self

Create a new BufferedUarte without hardware flow control.

Panics

Panics if rx_buffer.len() is odd.

pub fn new_with_rtscts( uarte: impl Peripheral<P = U> + 'd, timer: impl Peripheral<P = T> + 'd, ppi_ch1: impl Peripheral<P = impl ConfigurableChannel> + 'd, ppi_ch2: impl Peripheral<P = impl ConfigurableChannel> + 'd, ppi_group: impl Peripheral<P = impl Group> + 'd, _irq: impl Binding<U::Interrupt, InterruptHandler<U>> + 'd, rxd: impl Peripheral<P = impl GpioPin> + 'd, txd: impl Peripheral<P = impl GpioPin> + 'd, cts: impl Peripheral<P = impl GpioPin> + 'd, rts: impl Peripheral<P = impl GpioPin> + 'd, config: Config, rx_buffer: &'d mut [u8], tx_buffer: &'d mut [u8], ) -> Self

Create a new BufferedUarte with hardware flow control (RTS/CTS)

Panics

Panics if rx_buffer.len() is odd.

pub fn set_baudrate(&mut self, baudrate: Baudrate)

Adjust the baud rate to the provided value.

pub fn split(self) -> (BufferedUarteRx<'d, U, T>, BufferedUarteTx<'d, U>)

Split the UART in reader and writer parts.

This allows reading and writing concurrently from independent tasks.

pub fn split_by_ref( &mut self, ) -> (&mut BufferedUarteRx<'d, U, T>, &mut BufferedUarteTx<'d, U>)

Split the UART in reader and writer parts, by reference.

The returned halves borrow from self, so you can drop them and go back to using the “un-split” self. This allows temporarily splitting the UART.

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

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

pub 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.

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

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

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

Try writing a buffer without waiting, returning how many bytes were written.

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

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

Trait Implementations

impl<'d, U: UarteInstance, T: TimerInstance> BufRead for BufferedUarte<'d, U, T>

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<'d, U: UarteInstance, T: TimerInstance> ErrorType for BufferedUarte<'d, U, T>

type Error = Error

Error type of all the IO operations on this type.

impl<'d, U: UarteInstance, T: TimerInstance> Read for BufferedUarte<'d, U, T>

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<'d, U: UarteInstance, T: TimerInstance + 'd> ReadReady for BufferedUarte<'d, U, T>

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

Get whether the reader is ready for immediately reading.

impl<'d, U: UarteInstance, T: TimerInstance> Write for BufferedUarte<'d, U, T>

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<'d, U: UarteInstance, T: TimerInstance> Unpin for BufferedUarte<'d, U, T>