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

source

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

source

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.

source

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

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

pub fn drop(&mut self)

Executes the destructor for this type. Read more

source

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

source

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

Performs the conversion.

source

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

source

pub 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;`

Performs the conversion.

source

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

source

pub fn from(f: FutureObj<'a, T>) -> LocalFutureObj<'a, T>ⓘ
Notable traits for LocalFutureObj<'_, T>
`impl<'_, T> Future for LocalFutureObj<'_, T> type Output = T;`

Performs the conversion.

source

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

source

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

Performs the conversion.

source

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

source

pub 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;`

Performs the conversion.

source

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

type Output = T

The type of value produced on completion.

source

pub 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

source

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

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

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

type Output = <F as Future>::Output

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

The output that the future will produce on completion.

type Future = F

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

Which kind of future are we turning this into?

source

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

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

Creates a future from a value.

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

source

pub 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

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct futures_util::task::LocalFutureObj

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>,

pub unsafe fn into_future_obj(self) -> FutureObj<'a, T>ⓘNotable traits for FutureObj<'_, T>impl<'_, T> Future for FutureObj<'_, T> type Output = T;

Safety

Trait Implementations

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

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

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

pub fn drop(&mut self)

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

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

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

pub 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;

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

pub fn from(f: FutureObj<'a, T>) -> LocalFutureObj<'a, T>ⓘNotable traits for LocalFutureObj<'_, T>impl<'_, T> Future for LocalFutureObj<'_, T> type Output = T;

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

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

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

pub 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;

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

type Output = T

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

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,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Output = <F as Future>::Output

type Future = F

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

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

type Error = Infallible

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

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

type Ok = T

type Error = E

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

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

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

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

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>,

pub unsafe fn into_future_obj(self) -> FutureObj<'a, T>ⓘ
Notable traits for FutureObj<'_, T>
`impl<'_, T> Future for FutureObj<'_, T> type Output = T;`

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

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

pub 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;`

pub fn from(f: FutureObj<'a, T>) -> LocalFutureObj<'a, T>ⓘ
Notable traits for LocalFutureObj<'_, T>
`impl<'_, T> Future for LocalFutureObj<'_, T> type Output = T;`

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

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

pub 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;`

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

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

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

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

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

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

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

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

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

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