Struct futures_util::task::LocalFutureObj

source · [−]

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

Expand description

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>ⓘNotable traits for LocalFutureObj<'_, T>`impl<T> Future for LocalFutureObj<'_, T> type Output = T;` where
F: 'a + UnsafeFutureObj<'a, T>,

Create a LocalFutureObj from a custom trait object representation.

pub unsafe fn into_future_obj(self) -> FutureObj<'a, T>ⓘNotable traits for FutureObj<'_, T>`impl<T> Future for FutureObj<'_, T> type Output = 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. Read more

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

fn drop(&mut self)

Executes the destructor for this type. Read more

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

fn from(boxed: Box<F, Global>) -> LocalFutureObj<'a, ()>ⓘNotable traits for LocalFutureObj<'_, T>`impl<T> Future for LocalFutureObj<'_, T> type Output = T;`

Converts to this type from the input type.

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

fn from(
boxed: Box<dyn Future<Output = ()> + 'a, Global>
) -> LocalFutureObj<'a, ()>ⓘNotable traits for LocalFutureObj<'_, T>`impl<T> Future for LocalFutureObj<'_, T> type Output = T;`

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>ⓘNotable traits for LocalFutureObj<'_, T>`impl<T> Future for LocalFutureObj<'_, T> type Output = T;`

Converts to this type from the input type.

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

fn from(boxed: Pin<Box<F, Global>>) -> LocalFutureObj<'a, ()>ⓘNotable traits for LocalFutureObj<'_, T>`impl<T> Future for LocalFutureObj<'_, T> type Output = T;`

Converts to this type from the input type.

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

fn from(
boxed: Pin<Box<dyn Future<Output = ()> + 'a, Global>>
) -> LocalFutureObj<'a, ()>ⓘNotable traits for LocalFutureObj<'_, T>`impl<T> Future for LocalFutureObj<'_, T> type Output = T;`

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. Read more

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

Auto Trait Implementations

impl<'a, T> !RefUnwindSafe for LocalFutureObj<'a, T>

impl<'a, T> !Send for LocalFutureObj<'a, T>

impl<'a, T> !Sync for LocalFutureObj<'a, T>

impl<'a, T> !UnwindSafe for LocalFutureObj<'a, T>

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<F> IntoFuture for F where
F: Future,

type Output = <F as Future>::Output

The output that the future will produce on completion.

type IntoFuture = F

Which kind of future are we turning this into?

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.