Trait futures::future::Future 1.36.0[−][src]
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub trait Future {
type Output;
pub fn poll(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Self::Output>;
}A future represents an asynchronous computation.
A future is a value that may not have finished computing yet. This kind of “asynchronous value” makes it possible for a thread to continue doing useful work while it waits for the value to become available.
The poll method
The core method of future, poll, attempts to resolve the future into a
final value. This method does not block if the value is not ready. Instead,
the current task is scheduled to be woken up when it’s possible to make
further progress by polling again. The context passed to the poll
method can provide a Waker, which is a handle for waking up the current
task.
When using a future, you generally won’t call poll directly, but instead
.await the value.
Associated Types
Loading content...Required methods
pub fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>[src]
Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.
Return value
This function returns:
Poll::Pendingif the future is not ready yetPoll::Ready(val)with the resultvalof this future if it finished successfully.
Once a future has finished, clients should not poll it again.
When a future is not ready yet, poll returns Poll::Pending and
stores a clone of the Waker copied from the current Context.
This Waker is then woken once the future can make progress.
For example, a future waiting for a socket to become
readable would call .clone() on the Waker and store it.
When a signal arrives elsewhere indicating that the socket is readable,
Waker::wake is called and the socket future’s task is awoken.
Once a task has been woken up, it should attempt to poll the future
again, which may or may not produce a final value.
Note that on multiple calls to poll, only the Waker from the
Context passed to the most recent call should be scheduled to
receive a wakeup.
Runtime characteristics
Futures alone are inert; they must be actively polled to make
progress, meaning that each time the current task is woken up, it should
actively re-poll pending futures that it still has an interest in.
The poll function is not called repeatedly in a tight loop – instead,
it should only be called when the future indicates that it is ready to
make progress (by calling wake()). If you’re familiar with the
poll(2) or select(2) syscalls on Unix it’s worth noting that futures
typically do not suffer the same problems of “all wakeups must poll
all events”; they are more like epoll(4).
An implementation of poll should strive to return quickly, and should
not block. Returning quickly prevents unnecessarily clogging up
threads or event loops. If it is known ahead of time that a call to
poll may end up taking awhile, the work should be offloaded to a
thread pool (or something similar) to ensure that poll can return
quickly.
Panics
Once a future has completed (returned Ready from poll), calling its
poll method again may panic, block forever, or cause other kinds of
problems; the Future trait places no requirements on the effects of
such a call. However, as the poll method is not marked unsafe,
Rust’s usual rules apply: calls must never cause undefined behavior
(memory corruption, incorrect use of unsafe functions, or the like),
regardless of the future’s state.
Trait Implementations
Implementations on Foreign Types
impl<F> Future for AssertUnwindSafe<F> where
F: Future, [src]
impl<F> Future for AssertUnwindSafe<F> where
F: Future, [src]impl<T, F> Future for PollFn<F> where
F: FnMut(&mut Context<'_>) -> Poll<T>, [src]
impl<T, F> Future for PollFn<F> where
F: FnMut(&mut Context<'_>) -> Poll<T>, [src]impl<T> Future for Ready<T>[src]
impl<T> Future for Ready<T>[src]impl<T> Future for Pending<T>[src]
impl<T> Future for Pending<T>[src]impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, [src]
impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, [src]impl<P> Future for Pin<P> where
P: Unpin + DerefMut,
<P as Deref>::Target: Future, [src]
impl<P> Future for Pin<P> where
P: Unpin + DerefMut,
<P as Deref>::Target: Future, [src]impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, [src]
impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, [src]Implementors
impl<'_, R, W> Future for CopyBuf<'_, R, W> where
R: AsyncBufRead,
W: AsyncWrite + Unpin + ?Sized, [src]
impl<'_, R, W> Future for CopyBuf<'_, R, W> where
R: AsyncBufRead,
W: AsyncWrite + Unpin + ?Sized, [src]impl<'_, Si, Item> Future for futures::sink::Close<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, [src]
impl<'_, Si, Item> Future for futures::sink::Close<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, [src]impl<'_, Si, Item> Future for futures::sink::Flush<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, [src]
impl<'_, Si, Item> Future for futures::sink::Flush<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, [src]impl<'_, Si, St, Ok, Error> Future for SendAll<'_, Si, St> where
Si: Sink<Ok, Error = Error> + Unpin + ?Sized,
St: Stream<Item = Result<Ok, Error>> + Unpin + ?Sized, [src]
impl<'_, Si, St, Ok, Error> Future for SendAll<'_, Si, St> where
Si: Sink<Ok, Error = Error> + Unpin + ?Sized,
St: Stream<Item = Result<Ok, Error>> + Unpin + ?Sized, [src]impl<'_, St> Future for SelectNextSome<'_, St> where
St: FusedStream + Unpin + ?Sized, [src]
impl<'_, St> Future for SelectNextSome<'_, St> where
St: FusedStream + Unpin + ?Sized, [src]impl<'_, T> Future for Cancellation<'_, T>[src]
impl<'_, T> Future for Cancellation<'_, T>[src]impl<'_, T> Future for LocalFutureObj<'_, T>[src]
impl<'_, T> Future for LocalFutureObj<'_, T>[src]impl<'_, W> Future for WriteVectored<'_, W> where
W: AsyncWrite + Unpin + ?Sized, [src]
impl<'_, W> Future for WriteVectored<'_, W> where
W: AsyncWrite + Unpin + ?Sized, [src]impl<'a, T> Future for BiLockAcquire<'a, T>[src]
impl<'a, T> Future for BiLockAcquire<'a, T>[src]type Output = BiLockGuard<'a, T>
pub fn poll(
self: Pin<&mut BiLockAcquire<'a, T>>,
cx: &mut Context<'_>
) -> Poll<<BiLockAcquire<'a, T> as Future>::Output>[src]
self: Pin<&mut BiLockAcquire<'a, T>>,
cx: &mut Context<'_>
) -> Poll<<BiLockAcquire<'a, T> as Future>::Output>
impl<'a, T> Future for MutexLockFuture<'a, T> where
T: ?Sized, [src]
impl<'a, T> Future for MutexLockFuture<'a, T> where
T: ?Sized, [src]type Output = MutexGuard<'a, T>
pub fn poll(
self: Pin<&mut MutexLockFuture<'a, T>>,
cx: &mut Context<'_>
) -> Poll<<MutexLockFuture<'a, T> as Future>::Output>[src]
self: Pin<&mut MutexLockFuture<'a, T>>,
cx: &mut Context<'_>
) -> Poll<<MutexLockFuture<'a, T> as Future>::Output>
impl<A, B> Future for Either<A, B> where
B: Future<Output = <A as Future>::Output>,
A: Future, [src]
impl<A, B> Future for Either<A, B> where
B: Future<Output = <A as Future>::Output>,
A: Future, [src]impl<F> Future for OptionFuture<F> where
F: Future, [src]
impl<F> Future for OptionFuture<F> where
F: Future, [src]impl<F> Future for TryJoinAll<F> where
F: TryFuture, [src]
impl<F> Future for TryJoinAll<F> where
F: TryFuture, [src]impl<Fut1, Fut2> Future for TryFlatten<Fut1, Fut2> where
TryFlatten<Fut1, Fut2>: Future, [src]
impl<Fut1, Fut2> Future for TryFlatten<Fut1, Fut2> where
TryFlatten<Fut1, Fut2>: Future, [src]impl<Fut1, Fut2> Future for TryJoin<Fut1, Fut2> where
Fut1: TryFuture,
Fut2: TryFuture<Error = <Fut1 as TryFuture>::Error>, [src]
impl<Fut1, Fut2> Future for TryJoin<Fut1, Fut2> where
Fut1: TryFuture,
Fut2: TryFuture<Error = <Fut1 as TryFuture>::Error>, [src]impl<Fut1, Fut2, F> Future for AndThen<Fut1, Fut2, F> where
TryFlatten<MapOk<Fut1, F>, Fut2>: Future, [src]
impl<Fut1, Fut2, F> Future for AndThen<Fut1, Fut2, F> where
TryFlatten<MapOk<Fut1, F>, Fut2>: Future, [src]impl<Fut1, Fut2, F> Future for OrElse<Fut1, Fut2, F> where
TryFlattenErr<MapErr<Fut1, F>, Fut2>: Future, [src]
impl<Fut1, Fut2, F> Future for OrElse<Fut1, Fut2, F> where
TryFlattenErr<MapErr<Fut1, F>, Fut2>: Future, [src]impl<Fut1, Fut2, Fut3> Future for Join3<Fut1, Fut2, Fut3> where
Fut1: Future,
Fut2: Future,
Fut3: Future, [src]
impl<Fut1, Fut2, Fut3> Future for Join3<Fut1, Fut2, Fut3> where
Fut1: Future,
Fut2: Future,
Fut3: Future, [src]impl<Fut1, Fut2, Fut3> Future for TryJoin3<Fut1, Fut2, Fut3> where
Fut1: TryFuture,
Fut2: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut3: TryFuture<Error = <Fut1 as TryFuture>::Error>, [src]
impl<Fut1, Fut2, Fut3> Future for TryJoin3<Fut1, Fut2, Fut3> where
Fut1: TryFuture,
Fut2: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut3: TryFuture<Error = <Fut1 as TryFuture>::Error>, [src]impl<Fut1, Fut2, Fut3, Fut4> Future for Join4<Fut1, Fut2, Fut3, Fut4> where
Fut1: Future,
Fut2: Future,
Fut3: Future,
Fut4: Future, [src]
impl<Fut1, Fut2, Fut3, Fut4> Future for Join4<Fut1, Fut2, Fut3, Fut4> where
Fut1: Future,
Fut2: Future,
Fut3: Future,
Fut4: Future, [src]impl<Fut1, Fut2, Fut3, Fut4> Future for TryJoin4<Fut1, Fut2, Fut3, Fut4> where
Fut1: TryFuture,
Fut2: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut3: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut4: TryFuture<Error = <Fut1 as TryFuture>::Error>, [src]
impl<Fut1, Fut2, Fut3, Fut4> Future for TryJoin4<Fut1, Fut2, Fut3, Fut4> where
Fut1: TryFuture,
Fut2: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut3: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut4: TryFuture<Error = <Fut1 as TryFuture>::Error>, [src]type Output = Result<(<Fut1 as TryFuture>::Ok, <Fut2 as TryFuture>::Ok, <Fut3 as TryFuture>::Ok, <Fut4 as TryFuture>::Ok), <Fut1 as TryFuture>::Error>
pub fn poll(
self: Pin<&mut TryJoin4<Fut1, Fut2, Fut3, Fut4>>,
cx: &mut Context<'_>
) -> Poll<<TryJoin4<Fut1, Fut2, Fut3, Fut4> as Future>::Output>[src]
self: Pin<&mut TryJoin4<Fut1, Fut2, Fut3, Fut4>>,
cx: &mut Context<'_>
) -> Poll<<TryJoin4<Fut1, Fut2, Fut3, Fut4> as Future>::Output>
impl<Fut1, Fut2, Fut3, Fut4, Fut5> Future for Join5<Fut1, Fut2, Fut3, Fut4, Fut5> where
Fut1: Future,
Fut2: Future,
Fut3: Future,
Fut4: Future,
Fut5: Future, [src]
impl<Fut1, Fut2, Fut3, Fut4, Fut5> Future for Join5<Fut1, Fut2, Fut3, Fut4, Fut5> where
Fut1: Future,
Fut2: Future,
Fut3: Future,
Fut4: Future,
Fut5: Future, [src]type Output = (<Fut1 as Future>::Output, <Fut2 as Future>::Output, <Fut3 as Future>::Output, <Fut4 as Future>::Output, <Fut5 as Future>::Output)
pub fn poll(
self: Pin<&mut Join5<Fut1, Fut2, Fut3, Fut4, Fut5>>,
cx: &mut Context<'_>
) -> Poll<<Join5<Fut1, Fut2, Fut3, Fut4, Fut5> as Future>::Output>[src]
self: Pin<&mut Join5<Fut1, Fut2, Fut3, Fut4, Fut5>>,
cx: &mut Context<'_>
) -> Poll<<Join5<Fut1, Fut2, Fut3, Fut4, Fut5> as Future>::Output>
impl<Fut1, Fut2, Fut3, Fut4, Fut5> Future for TryJoin5<Fut1, Fut2, Fut3, Fut4, Fut5> where
Fut1: TryFuture,
Fut2: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut3: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut4: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut5: TryFuture<Error = <Fut1 as TryFuture>::Error>, [src]
impl<Fut1, Fut2, Fut3, Fut4, Fut5> Future for TryJoin5<Fut1, Fut2, Fut3, Fut4, Fut5> where
Fut1: TryFuture,
Fut2: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut3: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut4: TryFuture<Error = <Fut1 as TryFuture>::Error>,
Fut5: TryFuture<Error = <Fut1 as TryFuture>::Error>, [src]type Output = Result<(<Fut1 as TryFuture>::Ok, <Fut2 as TryFuture>::Ok, <Fut3 as TryFuture>::Ok, <Fut4 as TryFuture>::Ok, <Fut5 as TryFuture>::Ok), <Fut1 as TryFuture>::Error>
pub fn poll(
self: Pin<&mut TryJoin5<Fut1, Fut2, Fut3, Fut4, Fut5>>,
cx: &mut Context<'_>
) -> Poll<<TryJoin5<Fut1, Fut2, Fut3, Fut4, Fut5> as Future>::Output>[src]
self: Pin<&mut TryJoin5<Fut1, Fut2, Fut3, Fut4, Fut5>>,
cx: &mut Context<'_>
) -> Poll<<TryJoin5<Fut1, Fut2, Fut3, Fut4, Fut5> as Future>::Output>
impl<Fut> Future for TryMaybeDone<Fut> where
Fut: TryFuture, [src]
impl<Fut> Future for TryMaybeDone<Fut> where
Fut: TryFuture, [src]impl<Fut> Future for Compat01As03<Fut> where
Fut: Future, [src]
impl<Fut> Future for Compat01As03<Fut> where
Fut: Future, [src]impl<Fut> Future for CatchUnwind<Fut> where
Fut: Future + UnwindSafe, [src]
impl<Fut> Future for CatchUnwind<Fut> where
Fut: Future + UnwindSafe, [src]impl<Fut> Future for IntoFuture<Fut> where
Fut: TryFuture, [src]
impl<Fut> Future for IntoFuture<Fut> where
Fut: TryFuture, [src]impl<Fut> Future for NeverError<Fut> where
Map<Fut, OkFn<Infallible>>: Future, [src]
impl<Fut> Future for NeverError<Fut> where
Map<Fut, OkFn<Infallible>>: Future, [src]type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output
pub fn poll(
self: Pin<&mut NeverError<Fut>>,
cx: &mut Context<'_>
) -> Poll<<NeverError<Fut> as Future>::Output>[src]
self: Pin<&mut NeverError<Fut>>,
cx: &mut Context<'_>
) -> Poll<<NeverError<Fut> as Future>::Output>
impl<Fut, F> Future for InspectErr<Fut, F> where
Inspect<IntoFuture<Fut>, InspectErrFn<F>>: Future, [src]
impl<Fut, F> Future for InspectErr<Fut, F> where
Inspect<IntoFuture<Fut>, InspectErrFn<F>>: Future, [src]type Output = <Inspect<IntoFuture<Fut>, InspectErrFn<F>> as Future>::Output
pub fn poll(
self: Pin<&mut InspectErr<Fut, F>>,
cx: &mut Context<'_>
) -> Poll<<InspectErr<Fut, F> as Future>::Output>[src]
self: Pin<&mut InspectErr<Fut, F>>,
cx: &mut Context<'_>
) -> Poll<<InspectErr<Fut, F> as Future>::Output>
impl<Fut, F> Future for InspectOk<Fut, F> where
Inspect<IntoFuture<Fut>, InspectOkFn<F>>: Future, [src]
impl<Fut, F> Future for InspectOk<Fut, F> where
Inspect<IntoFuture<Fut>, InspectOkFn<F>>: Future, [src]impl<Fut, F> Future for UnwrapOrElse<Fut, F> where
Map<IntoFuture<Fut>, UnwrapOrElseFn<F>>: Future, [src]
impl<Fut, F> Future for UnwrapOrElse<Fut, F> where
Map<IntoFuture<Fut>, UnwrapOrElseFn<F>>: Future, [src]type Output = <Map<IntoFuture<Fut>, UnwrapOrElseFn<F>> as Future>::Output
pub fn poll(
self: Pin<&mut UnwrapOrElse<Fut, F>>,
cx: &mut Context<'_>
) -> Poll<<UnwrapOrElse<Fut, F> as Future>::Output>[src]
self: Pin<&mut UnwrapOrElse<Fut, F>>,
cx: &mut Context<'_>
) -> Poll<<UnwrapOrElse<Fut, F> as Future>::Output>
impl<Fut, F, G> Future for MapOkOrElse<Fut, F, G> where
Map<IntoFuture<Fut>, ChainFn<MapOkFn<F>, ChainFn<MapErrFn<G>, MergeResultFn>>>: Future, [src]
impl<Fut, F, G> Future for MapOkOrElse<Fut, F, G> where
Map<IntoFuture<Fut>, ChainFn<MapOkFn<F>, ChainFn<MapErrFn<G>, MergeResultFn>>>: Future, [src]type Output = <Map<IntoFuture<Fut>, ChainFn<MapOkFn<F>, ChainFn<MapErrFn<G>, MergeResultFn>>> as Future>::Output
pub fn poll(
self: Pin<&mut MapOkOrElse<Fut, F, G>>,
cx: &mut Context<'_>
) -> Poll<<MapOkOrElse<Fut, F, G> as Future>::Output>[src]
self: Pin<&mut MapOkOrElse<Fut, F, G>>,
cx: &mut Context<'_>
) -> Poll<<MapOkOrElse<Fut, F, G> as Future>::Output>
impl<St> Future for Concat<St> where
St: Stream,
<St as Stream>::Item: Extend<<<St as Stream>::Item as IntoIterator>::Item>,
<St as Stream>::Item: IntoIterator,
<St as Stream>::Item: Default, [src]
impl<St> Future for Concat<St> where
St: Stream,
<St as Stream>::Item: Extend<<<St as Stream>::Item as IntoIterator>::Item>,
<St as Stream>::Item: IntoIterator,
<St as Stream>::Item: Default, [src]impl<St> Future for StreamFuture<St> where
St: Stream + Unpin, [src]
impl<St> Future for StreamFuture<St> where
St: Stream + Unpin, [src]impl<St> Future for TryConcat<St> where
St: TryStream,
<St as TryStream>::Ok: Extend<<<St as TryStream>::Ok as IntoIterator>::Item>,
<St as TryStream>::Ok: IntoIterator,
<St as TryStream>::Ok: Default, [src]
impl<St> Future for TryConcat<St> where
St: TryStream,
<St as TryStream>::Ok: Extend<<<St as TryStream>::Ok as IntoIterator>::Item>,
<St as TryStream>::Ok: IntoIterator,
<St as TryStream>::Ok: Default, [src]impl<St, A, B, FromA, FromB> Future for Unzip<St, FromA, FromB> where
St: Stream<Item = (A, B)>,
FromA: Default + Extend<A>,
FromB: Default + Extend<B>, [src]
impl<St, A, B, FromA, FromB> Future for Unzip<St, FromA, FromB> where
St: Stream<Item = (A, B)>,
FromA: Default + Extend<A>,
FromB: Default + Extend<B>, [src]impl<St, C> Future for Collect<St, C> where
C: Default + Extend<<St as Stream>::Item>,
St: Stream, [src]
impl<St, C> Future for Collect<St, C> where
C: Default + Extend<<St as Stream>::Item>,
St: Stream, [src]impl<St, C> Future for TryCollect<St, C> where
C: Default + Extend<<St as TryStream>::Ok>,
St: TryStream, [src]
impl<St, C> Future for TryCollect<St, C> where
C: Default + Extend<<St as TryStream>::Ok>,
St: TryStream, [src]impl<St, Fut, F> Future for ForEach<St, Fut, F> where
F: FnMut(<St as Stream>::Item) -> Fut,
Fut: Future<Output = ()>,
St: Stream, [src]
impl<St, Fut, F> Future for ForEach<St, Fut, F> where
F: FnMut(<St as Stream>::Item) -> Fut,
Fut: Future<Output = ()>,
St: Stream, [src]impl<St, Fut, F> Future for ForEachConcurrent<St, Fut, F> where
F: FnMut(<St as Stream>::Item) -> Fut,
Fut: Future<Output = ()>,
St: Stream, [src]
impl<St, Fut, F> Future for ForEachConcurrent<St, Fut, F> where
F: FnMut(<St as Stream>::Item) -> Fut,
Fut: Future<Output = ()>,
St: Stream, [src]impl<St, Fut, F> Future for TryForEach<St, Fut, F> where
F: FnMut(<St as TryStream>::Ok) -> Fut,
Fut: TryFuture<Ok = (), Error = <St as TryStream>::Error>,
St: TryStream, [src]
impl<St, Fut, F> Future for TryForEach<St, Fut, F> where
F: FnMut(<St as TryStream>::Ok) -> Fut,
Fut: TryFuture<Ok = (), Error = <St as TryStream>::Error>,
St: TryStream, [src]impl<St, Fut, F> Future for TryForEachConcurrent<St, Fut, F> where
F: FnMut(<St as TryStream>::Ok) -> Fut,
Fut: Future<Output = Result<(), <St as TryStream>::Error>>,
St: TryStream, [src]
impl<St, Fut, F> Future for TryForEachConcurrent<St, Fut, F> where
F: FnMut(<St as TryStream>::Ok) -> Fut,
Fut: Future<Output = Result<(), <St as TryStream>::Error>>,
St: TryStream, [src]impl<St, Fut, T, F> Future for Fold<St, Fut, T, F> where
F: FnMut(T, <St as Stream>::Item) -> Fut,
Fut: Future<Output = T>,
St: Stream, [src]
impl<St, Fut, T, F> Future for Fold<St, Fut, T, F> where
F: FnMut(T, <St as Stream>::Item) -> Fut,
Fut: Future<Output = T>,
St: Stream, [src]impl<St, Fut, T, F> Future for TryFold<St, Fut, T, F> where
F: FnMut(T, <St as TryStream>::Ok) -> Fut,
Fut: TryFuture<Ok = T, Error = <St as TryStream>::Error>,
St: TryStream, [src]
impl<St, Fut, T, F> Future for TryFold<St, Fut, T, F> where
F: FnMut(T, <St as TryStream>::Ok) -> Fut,
Fut: TryFuture<Ok = T, Error = <St as TryStream>::Error>,
St: TryStream, [src]impl<St, Si> Future for Forward<St, Si> where
St: TryStream,
Forward<St, Si, <St as TryStream>::Ok>: Future, [src]
impl<St, Si> Future for Forward<St, Si> where
St: TryStream,
Forward<St, Si, <St as TryStream>::Ok>: Future, [src]impl<T> Future for RemoteHandle<T> where
T: 'static, [src]
impl<T> Future for RemoteHandle<T> where
T: 'static, [src]