Struct TxSink

pub struct TxSink<'a, BUF, PAYLOAD: TransferPayload>(/* private fields */);

A Sink-based asynchronous abstraction over a DMA transmitter.

Examples

let mut tx_sink = TxSink3::new(tx_buf, tx.with_dma(channels.2));
// Spams "01234567"
loop {
    tx_sink.send(*b"01234567").await.unwrap();
}

Implementations

impl<'a, BUF, PAYLOAD> TxSink<'a, BUF, PAYLOAD>

where TxSink<'a, BUF, PAYLOAD>: Sink<BUF, Error = Infallible>, PAYLOAD: Unpin + TransferPayload,

pub async fn release(self) -> (&'a mut BUF, PAYLOAD)

Releases the buffer and payload peripheral.

impl<'a, BUF> TxSink<'a, BUF, TxDma<Tx<USART1>, C4>>

pub fn new(buf: &'a mut BUF, tx: TxDma1) -> Self

Creates a new TxSink from the specified buffer and DMA transmitter.

impl<'a, BUF> TxSink<'a, BUF, TxDma<Tx<USART2>, C7>>

pub fn new(buf: &'a mut BUF, tx: TxDma2) -> Self

Creates a new TxSink from the specified buffer and DMA transmitter.

impl<'a, BUF> TxSink<'a, BUF, TxDma<Tx<USART3>, C2>>

pub fn new(buf: &'a mut BUF, tx: TxDma3) -> Self

Creates a new TxSink from the specified buffer and DMA transmitter.

Trait Implementations

impl<BUF, PAYLOAD> Sink<BUF> for TxSink<'static, BUF, PAYLOAD>

where &'static mut BUF: StaticReadBuffer<Word = u8>, PAYLOAD: WriteDma<&'static mut BUF, u8> + Unpin, TransferFuture<Transfer<R, &'static mut BUF, PAYLOAD>>: Future<Output = (&'static mut BUF, PAYLOAD)>,

type Error = Infallible

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: BUF) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.