Struct tokio_util::sync::ReusableBoxFuture

source · [−]

pub struct ReusableBoxFuture<T> { /* private fields */ }

Expand description

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

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

Implementations

source

impl<T> ReusableBoxFuture<T>

source

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

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

source

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

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.

source

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

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.

source

pub fn get_pin(&mut self) -> Pin<&mut (dyn Future<Output = T> + Send)>

Get a pinned reference to the underlying future.

source

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

Poll the future stored inside this box.

Trait Implementations

source

impl<T> Debug for ReusableBoxFuture<T>

source

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

Formats the value using the given formatter. Read more

source

impl<T> Drop for ReusableBoxFuture<T>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl<T> Future for ReusableBoxFuture<T>

source

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

Poll the future stored inside this box.

type Output = T

The type of value produced on completion.

source

impl<T> Send for ReusableBoxFuture<T>

source

impl<T> Sync for ReusableBoxFuture<T>

source

impl<T> Unpin for ReusableBoxFuture<T>

Auto Trait Implementations

impl<T> !RefUnwindSafe for ReusableBoxFuture<T>

impl<T> !UnwindSafe for ReusableBoxFuture<T>

Blanket Implementations

source

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

source

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

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

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

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into 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.

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 IntoFuture = F

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

Which kind of future are we turning this into?

source

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

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

Creates a future from a value. Read more

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

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

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

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

Performs the conversion.

Struct tokio_util::sync::ReusableBoxFuture

Implementations

impl<T> ReusableBoxFuture<T>

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

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

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

pub fn get_pin(&mut self) -> Pin<&mut (dyn Future<Output = T> + Send)>

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

Trait Implementations

impl<T> Debug for ReusableBoxFuture<T>

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

impl<T> Drop for ReusableBoxFuture<T>

fn drop(&mut self)

impl<T> Future for ReusableBoxFuture<T>

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

type Output = T

impl<T> Send for ReusableBoxFuture<T>

impl<T> Sync for ReusableBoxFuture<T>

impl<T> Unpin for ReusableBoxFuture<T>

Auto Trait Implementations

impl<T> !RefUnwindSafe for ReusableBoxFuture<T>

impl<T> !UnwindSafe for ReusableBoxFuture<T>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Output = <F as Future>::Output

type IntoFuture = F

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

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

type Error = Infallible

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

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

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

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

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

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

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,

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