Struct YieldToExecutorOnce

pub struct YieldToExecutorOnce(/* private fields */);

A future that yields to the executor only once.

This future returns [Poll::Pending] the first time it’s polled after waking the context waker. This effectively yields the currently running task to the executor, but puts it back in the executor’s ready task queue.

Example:

loop {
  let read = read_big_thing().await;

  while let Some(x) = read.next() {
    process_one_thing(x);
    YieldToExecutorOnce::new().await;
  }
}

Implementations

impl YieldToExecutorOnce

pub fn new() -> Self

Creates a new YieldToExecutorOnce.

Trait Implementations

impl Default for YieldToExecutorOnce

fn default() -> YieldToExecutorOnce

Returns the “default value” for a type.

impl FusedFuture for YieldToExecutorOnce

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

impl Future for YieldToExecutorOnce

type Output = ()

The type of value produced on completion.

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

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