Struct Yield 

pub struct Yield;

A unit structure that implements IntoFuture for a clean .await syntax.

Using Yield.await is the preferred way to cooperatively yield control back to the [Executor]. It ensures other tasks (like input handling) can run.

Example

async fn heavy_computation() {
    for i in 0..1000 {
        do_work(i);
        // Yield every iteration to prevent system hang
        Yield.await;
    }
}

Trait Implementations

impl Debug for Yield

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

Formats the value using the given formatter.

impl IntoFuture for Yield

type Output = ()

The output that the future will produce on completion.

type IntoFuture = _Yield

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.