Struct I2sParallelTransfer 

pub struct I2sParallelTransfer<'d, BUF, Dm>
where
    BUF: DmaTxBuffer,
    Dm: DriverMode,
{ /* private fields */ }

Available on crate feature unstable only.

Represents an ongoing (or potentially finished) transfer using the I2S parallel interface.

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.

Implementations

impl<'d, BUF, Dm> I2sParallelTransfer<'d, BUF, Dm>

where BUF: DmaTxBuffer, Dm: DriverMode,

pub fn is_done(&self) -> bool

Returns whether the transfer is complete.

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

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

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

where BUF: DmaTxBuffer,

Interrupt management for an ongoing transfer.

The driver itself has been consumed by I2sParallel::send, 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 set_interrupt_handler(&mut self, handler: InterruptHandler)

Sets the interrupt handler for the I2S parallel peripheral.

The new handler removes the old handler. This method does not turn on the interrupt sources. Use Self::listen to turn on interrupt sources.

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

Turns on the given interrupt sources.

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

Turns off the given interrupt sources.

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

Clears the interrupt flags of the given interrupt sources.

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

Returns the interrupt sources that are set.

impl<BUF> I2sParallelTransfer<'_, BUF, Async>

where BUF: DmaTxBuffer,

pub async fn wait_for_done(&mut self) -> Result<(), DmaError>

Waits for Self::is_done to return true.

Errors

Returns a DmaError when the transfer ends with a descriptor error.

Cancellation Safety

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

Trait Implementations

impl<BUF, Dm> Deref for I2sParallelTransfer<'_, BUF, Dm>

where BUF: DmaTxBuffer, Dm: DriverMode,

type Target = <BUF as DmaTxBuffer>::View

The resulting type after dereferencing.

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

Dereferences the value.

impl<BUF, Dm> DerefMut for I2sParallelTransfer<'_, BUF, Dm>

where BUF: DmaTxBuffer, Dm: DriverMode,

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

Mutably dereferences the value.

impl<BUF, Dm> Drop for I2sParallelTransfer<'_, BUF, Dm>

where BUF: DmaTxBuffer, Dm: DriverMode,

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.