Struct CameraTransfer 

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

Represents an ongoing (or potentially stopped) transfer from the Camera to a DMA buffer.

Implementations

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

pub fn is_done(&self) -> bool

Returns whether Self::wait will not block.

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

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

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

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

The camera does not really “finish” its transfer, so this typically waits for a DMA error. Call Self::stop once the needed data is available.

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

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

Waits for a DMA EOF or receive error in this transfer.

The EOF boundary is configured by Config::with_eof_mode. Reception can start partway through a frame, so EOF alone does not guarantee that a complete frame has been received.

This does not stop the camera or DMA. Call Self::stop to return the camera and buffer. After a successful wait, another call can wait for a later EOF. Receive errors are retained for this transfer. EOF status is latched: multiple EOFs before the wait consumes the status are reported as one event.

Errors

Returns DmaError::DescriptorError if DMA reports an invalid descriptor, descriptor exhaustion, or an error EOF. Receive errors take precedence over a pending EOF.

Cancellation Safety

Dropping the future does not stop the camera or DMA. The wait can be retried.

Trait Implementations

impl<BUF: DmaRxBuffer, Dm: DriverMode> Deref for CameraTransfer<'_, 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 CameraTransfer<'_, 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 CameraTransfer<'_, 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.