Struct Serial 

pub struct Serial<UART, TX, RX> { /* private fields */ }

Serial abstraction

Implementations

impl<UART: UartX, TX: TxPin<UART>, RX: RxPin<UART>> Serial<UART, TX, RX>

pub fn new(uart: UART, pins: (TX, RX), baud_rate: Bps, clocks: Clocks) -> Self

Configures a UART peripheral to provide serial communication

pub fn listen(self) -> Self

Starts listening for an interrupt event

pub fn unlisten(self) -> Self

Stops listening for an interrupt event

pub fn split(self) -> (Tx<UART, TX>, Rx<UART, RX>)

Splits the Serial abstraction into a transmitter and a receiver half

pub fn free(self) -> (UART, (TX, RX))

Releases the UART peripheral and associated pins

Trait Implementations

impl<UART: UartX, TX, RX> ErrorType for Serial<UART, TX, RX>

type Error = ErrorKind

Error type

impl<UART, TX, RX> ErrorType for Serial<UART, TX, RX>

type Error = ErrorKind

Error type of all the IO operations on this type.

impl<UART: UartX, TX, RX: RxPin<UART>> Read for Serial<UART, TX, RX>

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

Reads a single word from the serial interface

impl<UART: UartX, TX, RX: RxPin<UART>> Read for Serial<UART, TX, RX>

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<UART: UartX, TX: TxPin<UART>, RX> Write for Serial<UART, TX, RX>

fn write(&mut self, byte: 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<UART: UartX, TX: TxPin<UART>, RX> Write for Serial<UART, TX, RX>

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<UART: UartX, TX: TxPin<UART>, RX> WriteReady for Serial<UART, TX, RX>

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

Get whether the writer is ready for immediately writing.