Struct ParlIoRxTransfer 

pub struct ParlIoRxTransfer<'d, BUF: DmaRxBuffer, Dm: DriverMode> { /* private fields */ }

Represents an ongoing (or potentially finished) transfer using the PARL_IO RX.

Implementations

impl<BUF: DmaRxBuffer> ParlIoRxTransfer<'_, BUF, Async>

pub async fn wait_for_done(&mut self)

Waits for Self::is_done to return true.

Cancellation Safety

This method is cancellation safe. Dropping the future does not stop the transfer, and this method can be called again to wait for completion.

impl<'d, BUF: DmaRxBuffer, Dm: DriverMode> ParlIoRxTransfer<'d, BUF, Dm>

pub fn is_done(&self) -> bool

Returns whether Self::wait returns immediately.

pub fn wait(self) -> (Result<(), DmaError>, ParlIoRx<'d, Dm>, BUF::Final)

Waits for the transfer to finish and returns the peripheral and buffer.

impl<'d, BUF> ParlIoRxTransfer<'d, BUF, Blocking>

where BUF: DmaRxBuffer,

Interrupt management for an ongoing RX transfer.

The driver itself has been consumed by ParlIoRx::read, so these methods take &self and allow an interrupt handler to manage the interrupt sources through the transfer object.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn listen(&self, interrupts: impl Into<EnumSet<ParlIoRxInterrupt>>)

Listens for the given PARL_IO RX interrupt sources.

pub fn unlisten(&self, interrupts: impl Into<EnumSet<ParlIoRxInterrupt>>)

Stops listening for the given PARL_IO RX interrupt sources.

pub fn interrupts(&self) -> EnumSet<ParlIoRxInterrupt>

Returns the asserted PARL_IO RX interrupt sources.

pub fn clear_interrupts( &self, interrupts: impl Into<EnumSet<ParlIoRxInterrupt>>, )

Clears the interrupt flags of the given PARL_IO RX interrupt sources.

pub fn listen_dma(&self, interrupts: impl Into<EnumSet<DmaRxInterrupt>>)

Listens for the given DMA RX interrupt sources.

A handler must have been registered via ParlIoRx::set_dma_interrupt_handler before the transfer was started.

pub fn unlisten_dma(&self, interrupts: impl Into<EnumSet<DmaRxInterrupt>>)

Stops listening for the given DMA RX interrupt sources.

pub fn interrupts_dma(&self) -> EnumSet<DmaRxInterrupt>

Returns the asserted DMA RX interrupt sources.

pub fn clear_interrupts_dma( &self, interrupts: impl Into<EnumSet<DmaRxInterrupt>>, )

Clears the given asserted DMA RX interrupt sources.

Trait Implementations

impl<BUF: DmaRxBuffer, Dm: DriverMode> Deref for ParlIoRxTransfer<'_, BUF, Dm>

Available on crate feature unstable only.

type Target = <BUF as DmaRxBuffer>::View

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<BUF: DmaRxBuffer, Dm: DriverMode> DerefMut for ParlIoRxTransfer<'_, BUF, Dm>

Available on crate feature unstable only.

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<BUF: DmaRxBuffer, Dm: DriverMode> Drop for ParlIoRxTransfer<'_, BUF, Dm>

Available on crate feature unstable only.

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.