Struct futures_task::FutureObj

pub struct FutureObj<'a, T>(_);

A custom trait object for polling futures, roughly akin to Box<dyn Future<Output = T> + Send + 'a>.

This custom trait object was introduced as currently it is not possible to take dyn Trait by value and Box<dyn Trait> is not available in no_std contexts.

You should generally not need to use this type outside of no_std or when implementing Spawn, consider using BoxFuture instead.

Implementations

impl<'a, T> FutureObj<'a, T>

pub fn new<F: UnsafeFutureObj<'a, T> + Send>(f: F) -> Self

Create a FutureObj from a custom trait object representation.

Trait Implementations

impl<T, '_> Debug for FutureObj<'_, T>

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

Formats the value using the given formatter.

impl<'a, F: Future<Output = ()> + Send + 'a> From<Box<F, Global>> for FutureObj<'a, ()>

pub fn from(boxed: Box<F>) -> Self

Performs the conversion.

impl<'a> From<Box<dyn Future<Output = ()> + 'a + Send, Global>> for FutureObj<'a, ()>

pub fn from(boxed: Box<dyn Future<Output = ()> + Send + 'a>) -> Self

Performs the conversion.

impl<'a, T> From<FutureObj<'a, T>> for LocalFutureObj<'a, T>

pub fn from(f: FutureObj<'a, T>) -> Self

Performs the conversion.

impl<'a, F: Future<Output = ()> + Send + 'a> From<Pin<Box<F, Global>>> for FutureObj<'a, ()>

pub fn from(boxed: Pin<Box<F>>) -> Self

Performs the conversion.

impl<'a> From<Pin<Box<dyn Future<Output = ()> + 'a + Send, Global>>> for FutureObj<'a, ()>

pub fn from(boxed: Pin<Box<dyn Future<Output = ()> + Send + 'a>>) -> Self

Performs the conversion.

impl<T, '_> Future for FutureObj<'_, T>

type Output = T

The type of value produced on completion.

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

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

impl<T, '_> Send for FutureObj<'_, T>

impl<T, '_> Unpin for FutureObj<'_, T>