Struct DpiTransfer 

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

Represents an ongoing (or potentially finished) transfer using the RGB LCD interface

Implementations

impl<'d, BUF: DmaTxBuffer, Dm: DriverMode> DpiTransfer<'d, BUF, Dm>

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

Available on crate feature unstable only.

Returns the asserted LCD interrupt sources for this transfer.

Each source is a latched flag, so repeated events before clearing are reported as one. This reads raw status and does not require interrupt listening to be enabled.

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 clear_interrupts(&self, interrupts: impl Into<EnumSet<DpiInterrupt>>)

Available on crate feature unstable only.

Clears the selected LCD interrupt sources.

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 is_done(&self) -> bool

Returns whether Self::wait will not block.

pub fn stop(self) -> (Dpi<'d, Dm>, BUF::Final)

Stops this transfer on the spot and returns the peripheral and buffer.

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

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

If next_frame_en was specified as true in Dpi::send, this waits for a DMA error.

impl<BUF: DmaTxBuffer> DpiTransfer<'_, BUF, Blocking>

pub fn wait_for_vsync(&mut self)

Available on crate feature unstable only.

Waits for a pending LCD VSYNC event and clears it.

If a VSYNC event is already pending, this returns immediately. The transfer must remain active for another VSYNC to occur. Clear DpiInterrupt::Vsync with Self::clear_interrupts first to wait for a fresh event.

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.

impl<BUF: DmaTxBuffer> DpiTransfer<'_, BUF, Async>

pub async fn wait_for_vsync(&mut self)

Available on crate feature unstable only.

Waits for the next pending LCD VSYNC event and clears it.

If a VSYNC event is already pending, this returns immediately. The transfer must remain active for another VSYNC to occur. Clear DpiInterrupt::Vsync with Self::clear_interrupts first to wait for a fresh event.

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.

Trait Implementations

impl<BUF: DmaTxBuffer, Dm: DriverMode> Deref for DpiTransfer<'_, BUF, Dm>

Available on crate feature unstable only.

type Target = <BUF as DmaTxBuffer>::View

The resulting type after dereferencing.

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

Dereferences the value.

impl<BUF: DmaTxBuffer, Dm: DriverMode> DerefMut for DpiTransfer<'_, BUF, Dm>

Available on crate feature unstable only.

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

Mutably dereferences the value.

impl<BUF: DmaTxBuffer, Dm: DriverMode> Drop for DpiTransfer<'_, 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.