Struct SpawnableFuture

pub struct SpawnableFuture<'a, O>(/* private fields */);

SpawnableFuture is a boxed future that can be spawned without incurring any more allocations i.e. it doesn’t end up with the double boxing that you end up with if you try and spawn Box<dyn Future>. It can be used in place of BoxFuture although it carries more overhead than BoxFuture, so it shouldn’t be used if it isn’t going to be spawned on a scope. SpawnableFuture implements Future but the future will not be running as a separate task if used this way. If polled and then later spawned, the spawned task will be polled again and any waker recorded when polled prior to spawning will be impotent.

Implementations

impl<'a, O> SpawnableFuture<'a, O>

pub fn new<F: Future<Output = O> + Send + 'a>(future: F) -> Self

where O: Send + 'a,

Creates a new spawnable future. To spawn the future on a scope, use either spawn_on or compute_on.

Trait Implementations

impl<O> Future for &mut SpawnableFuture<'_, O>

type Output = O

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.

impl<O> Spawnable for SpawnableFuture<'static, O>

type Output = O

The type of value produced on completion.

fn into_task(self, scope: ScopeHandle) -> AtomicFutureHandle<'static>

Converts to a task that can be spawned directly.

impl<O> Unpin for SpawnableFuture<'_, O>