embassy-stm32

Crates

git

Versions

stm32l053c6

Flavors

๐Ÿ“ฃ We want to hear from you! Fill the Rust Embedded 2024 micro-survey.

Struct embassy_stm32::usart::UartTx

source ยท
pub struct UartTx<'d, M: Mode> { /* private fields */ }
Expand description

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ยง

sourceยง

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

source

pub fn new<T: Instance>( peri: impl Peripheral<P = T> + 'd, tx: impl Peripheral<P = impl TxPin<T>> + 'd, tx_dma: impl Peripheral<P = impl TxDma<T>> + 'd, config: Config, ) -> Result<Self, ConfigError>

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

source

pub fn new_with_cts<T: Instance>( peri: impl Peripheral<P = T> + 'd, tx: impl Peripheral<P = impl TxPin<T>> + 'd, cts: impl Peripheral<P = impl CtsPin<T>> + 'd, tx_dma: impl Peripheral<P = impl TxDma<T>> + 'd, config: Config, ) -> Result<Self, ConfigError>

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

source

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

Initiate an asynchronous UART write

source

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

Wait until transmission complete

sourceยง

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

source

pub fn new_blocking<T: Instance>( peri: impl Peripheral<P = T> + 'd, tx: impl Peripheral<P = impl TxPin<T>> + 'd, 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.

source

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

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

sourceยง

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

source

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

Reconfigure the driver

source

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

Perform a blocking UART write

source

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

Block until transmission complete

source

pub fn send_break(&self)

Send break character

Trait Implementationsยง

sourceยง

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

sourceยง

fn drop(&mut self)

Executes the destructor for this type. Read more
sourceยง

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

sourceยง

type Error = Error

Error type of all the IO operations on this type.
sourceยง

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

sourceยง

type Error = Error

Error type
sourceยง

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

sourceยง

type Config = Config

The configuration type used by this driver.
sourceยง

type ConfigError = ConfigError

The error type that can occur if set_config fails.
sourceยง

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

Set the configuration of the driver.
sourceยง

impl Write for UartTx<'_, Async>

sourceยง

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

Write a buffer into this writer, returning how many bytes were written. Read more
sourceยง

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

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

async fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer. Read more
sourceยง

impl<M: Mode> Write for UartTx<'_, M>

sourceยง

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

Write a buffer into this writer, returning how many bytes were written. Read more
sourceยง

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

Flush this output stream, blocking until all intermediately buffered contents reach their destination.
sourceยง

fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer. Read more
sourceยง

fn write_fmt( &mut self, fmt: Arguments<'_>, ) -> Result<(), WriteFmtError<Self::Error>>

Write a formatted string into this writer, returning any error encountered. Read more
sourceยง

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

sourceยง

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

Writes a single word to the serial interface.
sourceยง

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

Ensures that none of the previously written words are still buffered.
sourceยง

impl<'d, M: Mode> Write<u8> for UartTx<'d, M>

sourceยง

type Error = Error

The type of error that can occur when writing
sourceยง

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

Writes a slice, blocking until everything has been written Read more
sourceยง

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

Block until the serial interface has sent all buffered words

Auto Trait Implementationsยง

ยง

impl<'d, M> Freeze for UartTx<'d, M>

ยง

impl<'d, M> !RefUnwindSafe for UartTx<'d, M>

ยง

impl<'d, M> Send for UartTx<'d, M>
where M: Send,

ยง

impl<'d, M> Sync for UartTx<'d, M>
where M: Sync,

ยง

impl<'d, M> Unpin for UartTx<'d, M>
where M: Unpin,

ยง

impl<'d, M> !UnwindSafe for UartTx<'d, M>

Blanket Implementationsยง

sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
sourceยง

impl<T> From<T> for T

sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.