Struct embedded_runtime::context::SleepFuture

pub struct SleepFuture { /* private fields */ }

A passive future that can be polled once before it becomes ready; useful to suspend the current context and up a timeslice to the runtime/other pending futures

Behaviour

Polling this future yields immediately WITHOUT WAKING THE WAKER AGAIN, making room for other futures to execute. This is useful to e.g. suspend the execution of the current routine if it cannot make any progress and has no associated event sources.

Important

Unlike SpinFuture, this future DOES NOT wake the waker again. If the runtime enters deep-sleep, you MUST ensure there are other pending futures or event sources to wake it up again.

Implementations

impl SleepFuture

pub const fn new() -> Self

Creates a new spin future

Note

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

Trait Implementations

impl Debug for SleepFuture

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

Formats the value using the given formatter.

impl Default for SleepFuture

fn default() -> SleepFuture

Returns the “default value” for a type.

impl Future for SleepFuture

type Output = ()

The type of value produced on completion.

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

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