Struct UartTx 

pub struct UartTx<'d, M: PeriMode> { /* private fields */ }

Tx-only UART Driver.

Can be obtained from Uart::split, or can be constructed independently, if you do not need the receiving half of the driver.

Implementations

impl<'d> UartTx<'d, Async>

pub fn new<T: Instance, D: TxDma<T>, A>( peri: Peri<'d, T>, tx: Peri<'d, impl TxPin<T, A>>, tx_dma: Peri<'d, D>, _irq: impl Binding<D::Interrupt, InterruptHandler<D>> + 'd, config: Config, ) -> Result<Self, ConfigError>

Useful if you only want Uart Tx. It saves 1 pin and consumes a little less power.

pub fn new_with_cts<T: Instance, D: TxDma<T>, A>( peri: Peri<'d, T>, tx: Peri<'d, impl TxPin<T, A>>, cts: Peri<'d, impl CtsPin<T, A>>, tx_dma: Peri<'d, D>, _irq: impl Binding<D::Interrupt, InterruptHandler<D>> + 'd, config: Config, ) -> Result<Self, ConfigError>

Create a new tx-only UART with a clear-to-send pin

pub fn new_master<T: Instance, D: TxDma<T>, A>( peri: Peri<'d, T>, ck: Peri<'d, impl CkPin<T, A>>, tx: Peri<'d, impl TxPin<T, A>>, tx_dma: Peri<'d, D>, _irq: impl Binding<D::Interrupt, InterruptHandler<D>> + 'd, config: Config, ) -> Result<Self, ConfigError>

Create a new tx-only USART in synchronous master mode.

pub fn new_master_with_cts<T: Instance, D: TxDma<T>, A>( peri: Peri<'d, T>, ck: Peri<'d, impl CkPin<T, A>>, tx: Peri<'d, impl TxPin<T, A>>, cts: Peri<'d, impl CtsPin<T, A>>, tx_dma: Peri<'d, D>, _irq: impl Binding<D::Interrupt, InterruptHandler<D>> + 'd, config: Config, ) -> Result<Self, ConfigError>

Create a new tx-only USART with a clear-to-send pin in synchronous master mode.

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

Initiate an asynchronous UART write

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

Wait until transmission complete

impl<'d> UartTx<'d, Blocking>

pub fn new_blocking<T: Instance, A>( peri: Peri<'d, T>, tx: Peri<'d, impl TxPin<T, A>>, config: Config, ) -> Result<Self, ConfigError>

Create a new blocking tx-only UART with no hardware flow control.

Useful if you only want Uart Tx. It saves 1 pin and consumes a little less power.

pub fn new_blocking_with_cts<T: Instance, A>( peri: Peri<'d, T>, tx: Peri<'d, impl TxPin<T, A>>, cts: Peri<'d, impl CtsPin<T, A>>, config: Config, ) -> Result<Self, ConfigError>

Create a new blocking tx-only UART with a clear-to-send pin

pub fn new_blocking_master<T: Instance, A>( peri: Peri<'d, T>, ck: Peri<'d, impl CkPin<T, A>>, tx: Peri<'d, impl TxPin<T, A>>, config: Config, ) -> Result<Self, ConfigError>

Create a new blocking tx-only USART in synchronous master mode.

pub fn new_blocking_master_with_cts<T: Instance, A>( peri: Peri<'d, T>, ck: Peri<'d, impl CkPin<T, A>>, tx: Peri<'d, impl TxPin<T, A>>, cts: Peri<'d, impl CtsPin<T, A>>, config: Config, ) -> Result<Self, ConfigError>

Create a new blocking tx-only USART with a clear-to-send pin in synchronous master mode.

impl<'d, M: PeriMode> UartTx<'d, M>

pub fn set_config(&mut self, config: &Config) -> Result<(), ConfigError>

Reconfigure the driver

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

Perform a blocking UART write

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

Block until transmission complete

pub fn send_break(&self)

Send break character

pub fn set_baudrate(&self, baudrate: u32) -> Result<(), ConfigError>

Set baudrate

Trait Implementations

impl<'d, M: PeriMode> Drop for UartTx<'d, M>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'d, M: PeriMode> ErrorType for UartTx<'d, M>

type Error = Error

Error type

impl<M: PeriMode> ErrorType for UartTx<'_, M>

type Error = Error

Error type of all the IO operations on this type.

impl<'d, M: PeriMode> SetConfig for UartTx<'d, M>

type Config = Config

The configuration type used by this driver.

type ConfigError = ConfigError

The error type that can occur if set_config fails.

fn set_config(&mut self, config: &Self::Config) -> Result<(), Self::ConfigError>

Set the configuration of the driver.

impl<'d, M: PeriMode> Write for UartTx<'d, M>

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<M: PeriMode> Write for UartTx<'_, M>

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 UartTx<'_, Async>

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, M: PeriMode> Write<u8> for UartTx<'d, M>

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