Struct tokio_util::sync::ReusableBoxFuture [−][src]
pub struct ReusableBoxFuture<T> { /* fields omitted */ }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
impl<T> ReusableBoxFuture<T>[src]
pub fn new<F>(future: F) -> Self where
F: Future<Output = T> + Send + 'static, [src]
F: Future<Output = T> + Send + 'static,
Create a new ReusableBoxFuture<T> containing the provided future.
pub fn set<F>(&mut self, future: F) where
F: Future<Output = T> + Send + 'static, [src]
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.
pub fn try_set<F>(&mut self, future: F) -> Result<(), F> where
F: Future<Output = T> + Send + 'static, [src]
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.
pub fn get_pin(&mut self) -> Pin<&mut (dyn Future<Output = T> + Send)>[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 ReusableBoxFuture<T>[src]
impl<T> Drop for ReusableBoxFuture<T>[src]
impl<T> Future for ReusableBoxFuture<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> Send for ReusableBoxFuture<T>[src]
impl<T> Sync for ReusableBoxFuture<T>[src]
impl<T> Unpin for ReusableBoxFuture<T>[src]
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, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<F> IntoFuture for F where
F: Future, [src]
F: Future,
type Output = <F as Future>::Output
into_future)The output that the future will produce on completion.
type Future = F
into_future)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized, [src]
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
pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>[src]
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,