Struct reusable_box_future::ReusableLocalBoxFuture[][src]

pub struct ReusableLocalBoxFuture<T> { /* fields omitted */ }

A reusable Pin<Box<dyn Future<Output = T>>.

This type lets you replace the future stored in the box without reallocating when the size and alignment permits this.

Implementations

impl<T> ReusableLocalBoxFuture<T>[src]

pub fn new<F>(future: F) -> Self where
    F: Future<Output = T> + 'static, 
[src]

Create a new ReusableLocalBoxFuture<T> containing the provided future.

pub fn set<F>(&mut self, future: F) where
    F: Future<Output = T> + 'static, 
[src]

Replace the future currently stored in this box.

This reallocates if and only if the layout of the provided future is different from the layout of the currently stored future.

pub fn try_set<F>(&mut self, future: F) -> Result<(), F> where
    F: Future<Output = T> + 'static, 
[src]

Replace the future currently stored in this box.

This function never reallocates, but returns an error if the provided future has a different size or alignment from the currently stored future.

pub fn get_pin(&mut self) -> Pin<&mut dyn Future<Output = T>>[src]

Get a pinned reference to the underlying future.

pub fn poll(&mut self, cx: &mut Context<'_>) -> Poll<T>[src]

Poll the future stored inside this box.

Trait Implementations

impl<T> Debug for ReusableLocalBoxFuture<T>[src]

impl<T> Drop for ReusableLocalBoxFuture<T>[src]

impl<T> Future for ReusableLocalBoxFuture<T>[src]

type Output = T

The type of value produced on completion.

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

Poll the future stored inside this box.

impl<T> Unpin for ReusableLocalBoxFuture<T>[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<F> IntoFuture for F where
    F: Future
[src]

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?

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.