1.36.0[−][src]Trait futures_core::future::Future

#[must_use = "futures do nothing unless you `.await` or poll them"]
#[lang = "future_trait"]
pub trait Future {
    type Output;
    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

type Output[−]

The type of value produced on completion.

Required methods

fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>[−]

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:

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

impl<'a, T> UnsafeFutureObj<'a, T> for &'a mut (dyn Future<Output = T> + Unpin + 'a)[src][+]

Implementations on Foreign Types

impl<F> Future for AssertUnwindSafe<F> where
    F: Future, [src][−]

type Output = <F as Future>::Output

impl<P> Future for Pin<P> where
    P: Unpin + DerefMut,
    <P as Deref>::Target: Future, [src][−]

type Output = <<P as Deref>::Target as Future>::Output

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, [src][−]

type Output = <F as Future>::Output

impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, [src][−]

type Output = <F as Future>::Output

Implementors

impl<'_, T> Future for FutureObj<'_, T>[src][−]

type Output = T

impl<'_, T> Future for LocalFutureObj<'_, T>[src][−]

type Output = T

impl<T> Future for Receiver<T>

impl<Fut: Future> Future for AssertUnmoved<Fut>

impl<Fut: Future> Future for PendingOnce<Fut>

impl<Fut: Future> Future for InterleavePending<Fut>

impl<R, F> Future for Lazy<F> where
    F: FnOnce(&mut Context) -> R, 

impl<T> Future for Pending<T>

impl<Fut: Future> Future for MaybeDone<Fut>

impl<F: Future> Future for OptionFuture<F>

impl<T, F> Future for PollFn<F> where
    F: FnMut(&mut Context) -> Poll<T>, 

impl<T> Future for Ready<T>

impl<Fut1: Future, Fut2: Future> Future for Join<Fut1, Fut2>

impl<Fut1: Future, Fut2: Future, Fut3: Future> Future for Join3<Fut1, Fut2, Fut3>

impl<Fut1: Future, Fut2: Future, Fut3: Future, Fut4: Future> Future for Join4<Fut1, Fut2, Fut3, Fut4>

impl<Fut1: Future, Fut2: Future, Fut3: Future, Fut4: Future, Fut5: Future> Future for Join5<Fut1, Fut2, Fut3, Fut4, Fut5>

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

impl<A: Unpin, B: Unpin> Future for Select<A, B> where
    A: Future,
    B: Future, 

impl<Fut: Future + Unpin> Future for SelectAll<Fut>

impl<Fut> Future for Flatten<Fut> where
    Fut: Future,
    Fut::Output: Future, 

impl<Fut: Future> Future for Fuse<Fut>

impl<Fut, F, T> Future for Map<Fut, F> where
    Fut: Future,
    F: FnOnce(Fut::Output) -> T, 

impl<Fut1, Fut2, F> Future for Then<Fut1, Fut2, F> where
    Fut1: Future,
    Fut2: Future,
    F: FnOnce(Fut1::Output) -> Fut2, 

impl<Fut, F> Future for Inspect<Fut, F> where
    Fut: Future,
    F: FnOnce(&Fut::Output), 

impl<Fut, T> Future for UnitError<Fut> where
    Fut: Future<Output = T>, 

impl<Fut, T> Future for NeverError<Fut> where
    Fut: Future<Output = T>, 

impl<A, B> Future for Either<A, B> where
    A: Future,
    B: Future<Output = A::Output>, 

impl<Fut> Future for Abortable<Fut> where
    Fut: Future, 

impl<Fut> Future for CatchUnwind<Fut> where
    Fut: Future + UnwindSafe, 

impl<T: Send + 'static> Future for RemoteHandle<T>

impl<Fut: Future> Future for Remote<Fut>

impl<Fut: Future> Future for Shared<Fut> where
    Fut::Output: Clone, 

impl<Fut1, Fut2> Future for TryJoin<Fut1, Fut2> where
    Fut1: TryFuture,
    Fut2: TryFuture<Error = Fut1::Error>, 

impl<Fut1, Fut2, Fut3> Future for TryJoin3<Fut1, Fut2, Fut3> where
    Fut1: TryFuture,
    Fut2: TryFuture<Error = Fut1::Error>,
    Fut3: TryFuture<Error = Fut1::Error>, 

impl<Fut1, Fut2, Fut3, Fut4> Future for TryJoin4<Fut1, Fut2, Fut3, Fut4> where
    Fut1: TryFuture,
    Fut2: TryFuture<Error = Fut1::Error>,
    Fut3: TryFuture<Error = Fut1::Error>,
    Fut4: TryFuture<Error = Fut1::Error>, 

impl<Fut1, Fut2, Fut3, Fut4, Fut5> Future for TryJoin5<Fut1, Fut2, Fut3, Fut4, Fut5> where
    Fut1: TryFuture,
    Fut2: TryFuture<Error = Fut1::Error>,
    Fut3: TryFuture<Error = Fut1::Error>,
    Fut4: TryFuture<Error = Fut1::Error>,
    Fut5: TryFuture<Error = Fut1::Error>, 

impl<F> Future for TryJoinAll<F> where
    F: TryFuture, 

impl<A: Unpin, B: Unpin> Future for TrySelect<A, B> where
    A: TryFuture,
    B: TryFuture, 

impl<Fut: TryFuture + Unpin> Future for SelectOk<Fut>

impl<Fut1, Fut2, F> Future for AndThen<Fut1, Fut2, F> where
    Fut1: TryFuture,
    Fut2: TryFuture<Error = Fut1::Error>,
    F: FnOnce(Fut1::Ok) -> Fut2, 

impl<Fut, E> Future for ErrInto<Fut, E> where
    Fut: TryFuture,
    Fut::Error: Into<E>, 

impl<Fut, F> Future for InspectOk<Fut, F> where
    Fut: TryFuture,
    F: FnOnce(&Fut::Ok), 

impl<Fut, F> Future for InspectErr<Fut, F> where
    Fut: TryFuture,
    F: FnOnce(&Fut::Error), 

impl<Fut: TryFuture> Future for IntoFuture<Fut>

impl<Fut, F, E> Future for MapErr<Fut, F> where
    Fut: TryFuture,
    F: FnOnce(Fut::Error) -> E, 

impl<Fut, F, T> Future for MapOk<Fut, F> where
    Fut: TryFuture,
    F: FnOnce(Fut::Ok) -> T, 

impl<Fut1, Fut2, F> Future for OrElse<Fut1, Fut2, F> where
    Fut1: TryFuture,
    Fut2: TryFuture<Ok = Fut1::Ok>,
    F: FnOnce(Fut1::Error) -> Fut2, 

impl<Fut, F> Future for UnwrapOrElse<Fut, F> where
    Fut: TryFuture,
    F: FnOnce(Fut::Error) -> Fut::Ok, 

impl<St, C> Future for Collect<St, C> where
    St: Stream,
    C: Default + Extend<St::Item>, 

impl<St> Future for Concat<St> where
    St: Stream,
    St::Item: Extend<<St::Item as IntoIterator>::Item> + IntoIterator + Default, 

impl<St, Fut, T, F> Future for Fold<St, Fut, T, F> where
    St: Stream,
    F: FnMut(T, St::Item) -> Fut,
    Fut: Future<Output = T>, 

impl<St, Si, Item, E> Future for Forward<St, Si> where
    Si: Sink<Item, Error = E>,
    St: Stream<Item = Result<Item, E>>, 

impl<St, Fut, F> Future for ForEach<St, Fut, F> where
    St: Stream,
    F: FnMut(St::Item) -> Fut,
    Fut: Future<Output = ()>, 

impl<St: Stream + Unpin> Future for StreamFuture<St>

impl<'_, St: ?Sized + Stream + Unpin> Future for Next<'_, St>

impl<'_, St: ?Sized + Stream + FusedStream + Unpin> Future for SelectNextSome<'_, St>

impl<St, Fut, F> Future for ForEachConcurrent<St, Fut, F> where
    St: Stream,
    F: FnMut(St::Item) -> Fut,
    Fut: Future<Output = ()>, 

impl<'_, St: ?Sized + TryStream + Unpin> Future for TryNext<'_, St>

impl<St, Fut, F> Future for TryForEach<St, Fut, F> where
    St: TryStream,
    F: FnMut(St::Ok) -> Fut,
    Fut: TryFuture<Ok = (), Error = St::Error>, 

impl<St, C> Future for TryCollect<St, C> where
    St: TryStream,
    C: Default + Extend<St::Ok>, 

impl<St> Future for TryConcat<St> where
    St: TryStream,
    St::Ok: Extend<<St::Ok as IntoIterator>::Item> + IntoIterator + Default, 

impl<St, Fut, T, F> Future for TryFold<St, Fut, T, F> where
    St: TryStream,
    F: FnMut(T, St::Ok) -> Fut,
    Fut: TryFuture<Ok = T, Error = St::Error>, 

impl<St, Fut, F> Future for TryForEachConcurrent<St, Fut, F> where
    St: TryStream,
    F: FnMut(St::Ok) -> Fut,
    Fut: Future<Output = Result<(), St::Error>>, 

impl<'_, Si: Sink<Item> + Unpin + ?Sized, Item> Future for Close<'_, Si, Item>

impl<'_, Si: Sink<Item> + Unpin + ?Sized, Item> Future for Flush<'_, Si, Item>

impl<'_, Si: Sink<Item> + Unpin + ?Sized, Item> Future for Send<'_, Si, Item>

impl<'_, Si: ?Sized, St: ?Sized> Future for SendAll<'_, Si, St> where
    Si: Sink<St::Item> + Unpin,
    St: Stream + Unpin, 

impl<Fut: Future01> Future for Compat01As03<Fut>

impl<'_, R: AsyncRead, W: AsyncWrite + Unpin + ?Sized> Future for CopyInto<'_, R, W>

impl<'_, R, W: ?Sized> Future for CopyBufInto<'_, R, W> where
    R: AsyncBufRead,
    W: AsyncWrite + Unpin, 

impl<'_, W: ?Sized> Future for Flush<'_, W> where
    W: AsyncWrite + Unpin, 

impl<'_, R: AsyncRead + ?Sized + Unpin> Future for Read<'_, R>

impl<'_, R: AsyncRead + ?Sized + Unpin> Future for ReadVectored<'_, R>

impl<'_, R: AsyncRead + ?Sized + Unpin> Future for ReadExact<'_, R>

impl<'_, R: AsyncBufRead + ?Sized + Unpin> Future for ReadLine<'_, R>

impl<'_, A: ?Sized> Future for ReadToEnd<'_, A> where
    A: AsyncRead + Unpin, 

impl<'_, R: AsyncBufRead + ?Sized + Unpin> Future for ReadUntil<'_, R>

impl<'_, W: AsyncWrite + ?Sized + Unpin> Future for Close<'_, W>

impl<'_, S: AsyncSeek + ?Sized + Unpin> Future for Seek<'_, S>

impl<'_, W: AsyncWrite + ?Sized + Unpin> Future for Write<'_, W>

impl<'_, W: AsyncWrite + ?Sized + Unpin> Future for WriteVectored<'_, W>

impl<'_, W: AsyncWrite + ?Sized + Unpin> Future for WriteAll<'_, W>

impl<'a, T: ?Sized> Future for MutexLockFuture<'a, T>

impl<'a, T> Future for BiLockAcquire<'a, T>