Struct embassy_nrf::buffered_uarte::BufferedUarteRx

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

Reader part of the buffered UARTE driver.

Implementations

impl<'d, U: UarteInstance, T: TimerInstance> BufferedUarteRx<'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, config: Config, rx_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_rts( 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, rts: impl Peripheral<P = impl GpioPin> + 'd, config: Config, rx_buffer: &'d mut [u8], ) -> Self

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

Panics

Panics if rx_buffer.len() is odd.

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.

Trait Implementations

impl<'d: 'd, U: UarteInstance, T: TimerInstance> BufRead for BufferedUarteRx<'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<'a, U: UarteInstance, T: TimerInstance> Drop for BufferedUarteRx<'a, U, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'d, U: UarteInstance, T: TimerInstance> ErrorType for BufferedUarteRx<'d, U, T>

type Error = Error

Error type of all the IO operations on this type.

impl<'d: 'd, U: UarteInstance, T: TimerInstance> Read for BufferedUarteRx<'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 BufferedUarteRx<'d, U, T>

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

Get whether the reader is ready for immediately reading.