Struct SpinFuture

pub struct SpinFuture { /* private fields */ }

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

Behaviour

Polling this future will immediately wake the waker again and yield, making room for other futures to execute. This is useful for e.g. running intensive loops or similar inside a future.

Implementations

impl SpinFuture

pub const fn new() -> Self

Creates a new spin future

Note

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

Trait Implementations

impl Debug for SpinFuture

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

Formats the value using the given formatter.

impl Default for SpinFuture

fn default() -> SpinFuture

Returns the “default value” for a type.

impl Future for SpinFuture

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.