Struct rp2040_hal::uart::Reader

pub struct Reader<D: UartDevice, P: ValidUartPinout<D>> { /* private fields */ }

Half of an UartPeripheral that is only capable of reading. Obtained by calling UartPeripheral::split()

Implementations

impl<D: UartDevice, P: ValidUartPinout<D>> Reader<D, P>

pub fn read_raw<'b>(&self, buffer: &'b mut [u8]) -> Result<usize, ReadError<'b>>

Reads bytes from the UART. This function reads as long as it can. As soon that the FIFO is empty, if :

• 0 bytes were read, a WouldBlock Error is returned
• some bytes were read, it is deemed to be a success Upon success, it will return how many bytes were read.

pub fn read_full_blocking(&self, buffer: &mut [u8]) -> Result<(), ReadErrorType>

Reads bytes from the UART. This function blocks until the full buffer has been received.

pub fn enable_rx_interrupt(&mut self)

Enables the Receive Interrupt.

The relevant UARTx IRQ will fire when there is data in the receive register.

pub fn disable_rx_interrupt(&mut self)

Disables the Receive Interrupt.

Trait Implementations

impl<D: UartDevice, P: ValidUartPinout<D>> ErrorType for Reader<D, P>

type Error = ReadErrorType

Error type

impl<D: UartDevice, P: ValidUartPinout<D>> ErrorType for Reader<D, P>

type Error = ReadErrorType

Error type of all the IO operations on this type.

impl<D: UartDevice, P: ValidUartPinout<D>> Read for Reader<D, P>

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<D: UartDevice, P: ValidUartPinout<D>> Read for Reader<D, P>

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

Reads a single word from the serial interface

impl<D: UartDevice, P: ValidUartPinout<D>> ReadTarget for Reader<D, P>

type ReceivedWord = u8

Type which is transferred in a single DMA transfer.

fn rx_treq() -> Option<u8>

Returns the DREQ number for this data source (None for memory buffers).

fn rx_address_count(&self) -> (u32, u32)

Returns the address and the maximum number of words that can be transferred from this data source in a single DMA operation.

fn rx_increment(&self) -> bool

Returns whether the address shall be incremented after each transfer.

impl<D: UartDevice, P: ValidUartPinout<D>> Read<u8> for Reader<D, P>

type Error = ReadErrorType

Read error

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

Reads a single word from the serial interface

impl<D: UartDevice, P: ValidUartPinout<D>> EndlessReadTarget for Reader<D, P>