Struct embedded_runtime_nrf52840::yield_::YieldFuture

pub struct YieldFuture { /* private fields */ }

A future that must be polled once before it becomes ready; useful to cooperatively give up a timeslice to the runtime/other pending futures

Calling this function will move the currently executing future to the back of the execution queue, making room for other futures to execute. This is especially useful after running CPU-intensive operations inside a future.

Implementations

impl YieldFuture

pub const fn new() -> YieldFuture

Creates a new yielding future

Note

This future should usually not be constructed directly, use yield_now instead.

Trait Implementations

impl Debug for YieldFuture

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Future for YieldFuture

type Output = ()

The type of value produced on completion.

fn poll( self: Pin<&mut YieldFuture>, cx: &mut Context<'_> ) -> Poll<<YieldFuture as Future>::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.