Struct esp32_hal::i2s::I2sReadDmaTransfer

pub struct I2sReadDmaTransfer<'d, T, CH, BUFFER>
where
    T: RegisterAccess,
    CH: ChannelTypes,
{ /* private fields */ }

An in-progress DMA read transfer.

Implementations

impl<'d, T, CH, BUFFER> I2sReadDmaTransfer<'d, T, CH, BUFFER>

where T: RegisterAccess, CH: ChannelTypes,

pub fn available(&mut self) -> usize

Amount of bytes which can be popped

pub fn pop(&mut self, data: &mut [u8]) -> Result<usize, Error>

pub fn wait_receive( self, dst: &mut [u8] ) -> Result<(BUFFER, I2sRx<'d, T, CH>, usize), (DmaError, BUFFER, I2sRx<'d, T, CH>, usize)>

Wait for the DMA transfer to complete and return the buffers and the I2sTx instance after copying the read data to the given buffer. Length of the received data is returned at the third element of the tuple.

Trait Implementations

impl<'d, T, CH, BUFFER> DmaTransfer<BUFFER, I2sRx<'d, T, CH>> for I2sReadDmaTransfer<'d, T, CH, BUFFER>

where T: RegisterAccess, CH: ChannelTypes,

fn wait( self ) -> Result<(BUFFER, I2sRx<'d, T, CH>), (DmaError, BUFFER, I2sRx<'d, T, CH>)>

Wait for the DMA transfer to complete and return the buffers and the I2sTx instance.

fn is_done(&self) -> bool

Check if the DMA transfer is complete

impl<T, CH, BUFFER> Drop for I2sReadDmaTransfer<'_, T, CH, BUFFER>

where T: RegisterAccess, CH: ChannelTypes,

fn drop(&mut self)

Executes the destructor for this type.