Struct futures_util::task::LocalFutureObj

pub struct LocalFutureObj<'a, T> { /* private fields */ }

A custom trait object for polling futures, roughly akin to Box<dyn Future<Output = T> + '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.

Implementations

impl<'a, T> LocalFutureObj<'a, T>

pub fn new<F>(f: F) -> LocalFutureObj<'a, T>

where F: UnsafeFutureObj<'a, T> + 'a,

Create a LocalFutureObj from a custom trait object representation.

pub unsafe fn into_future_obj(self) -> FutureObj<'a, T>

Converts the LocalFutureObj into a FutureObj.

Safety

To make this operation safe one has to ensure that the UnsafeFutureObj instance from which this LocalFutureObj was created actually implements Send.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T> Drop for LocalFutureObj<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, F> From<Box<F>> for LocalFutureObj<'a, ()>

where F: Future<Output = ()> + 'a,

fn from(boxed: Box<F>) -> LocalFutureObj<'a, ()>

Converts to this type from the input type.

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

fn from(boxed: Box<dyn Future<Output = ()> + 'a>) -> LocalFutureObj<'a, ()>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a, F> From<Pin<Box<F>>> for LocalFutureObj<'a, ()>

where F: Future<Output = ()> + 'a,

fn from(boxed: Pin<Box<F>>) -> LocalFutureObj<'a, ()>

Converts to this type from the input type.

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

fn from(boxed: Pin<Box<dyn Future<Output = ()> + 'a>>) -> LocalFutureObj<'a, ()>

Converts to this type from the input type.

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

type Output = T

The type of value produced on completion.

fn poll(self: Pin<&mut LocalFutureObj<'_, T>>, 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> Unpin for LocalFutureObj<'_, T>