Struct futures_core::future::LocalFutureObj

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

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

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

This custom trait object was introduced for two reasons:

• Currently it is not possible to take dyn Trait by value and Box<dyn Trait> is not available in no_std contexts.
• The Future trait is currently not object safe: The Future::poll method makes uses the arbitrary self types feature and traits in which this feature is used are currently not object safe due to current compiler limitations. (See tracking issue for arbitray self types for more information #44874)

Methods

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

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

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

Create a LocalFutureObj from a custom trait object representation.

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

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

Converts the LocalFutureObj into a FutureObj 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<'a, T> Drop for LocalFutureObj<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

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

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

Formats the value using the given formatter.

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

type Output = T

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

The result of the Future.

fn poll(self: PinMut<LocalFutureObj<'a, T>>, cx: &mut Context) -> Poll<T>

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

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

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'a, F> From<PinBox<F>> for LocalFutureObj<'a, ()> where     F: 'a + Future<Output = ()>,

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

Performs the conversion.