Struct dyn_future::DynFuture

#[must_use = "futures do nothing unless polled"]
pub struct DynFuture<T: 'static> { /* fields omitted */ }

Represents an asyncronous computation.

This is different from std::future::Future in that it is a fixed size struct with a boxed future inside.

Using this is advantageous over Box<dyn Future<Output = T>> due to less overhead.

Methods

impl<T> DynFuture<T>

pub fn new(f: impl Future<Output = T> + Send + 'static) -> Pin<Self>

Creates a new DynFuture from a std::future::Future.

This method may but rarely calls the global allocator. Almost all allocations occur via a fast path using a bump allocator.

pub fn into_boxed(self) -> Pin<Box<dyn Future<Output = T> + Send>>

Converts a DynFuture<T> into a Box<dyn Future<Output = T> + Send>.

pub fn from_boxed(boxed: Pin<Box<dyn Future<Output = T> + Send>>) -> Pin<Self>

Converts a Box<dyn Future<Output = T> + Send> into a DynFuture<T>.

Trait Implementations

impl<T> Send for DynFuture<T>

impl<T> Drop for DynFuture<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Deref for DynFuture<T>

type Target = dyn Future<Output = T> + Send

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for DynFuture<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Future for DynFuture<T>

type Output = T

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.