src/libcore/future/future.rs

   1 #![stable(feature = "futures_api", since = "1.36.0")]
   2
   3 use crate::marker::Unpin;
   4 use crate::ops;
   5 use crate::pin::Pin;
   6 use crate::task::{Context, Poll};
   7
   8 /// A future represents an asynchronous computation.
   9 ///
  10 /// A future is a value that may not have finished computing yet. This kind of
  11 /// "asynchronous value" makes it possible for a thread to continue doing useful
  12 /// work while it waits for the value to become available.
  13 ///
  14 /// # The `poll` method
  15 ///
  16 /// The core method of future, `poll`, *attempts* to resolve the future into a
  17 /// final value. This method does not block if the value is not ready. Instead,
  18 /// the current task is scheduled to be woken up when it's possible to make
  19 /// further progress by `poll`ing again. The `context` passed to the `poll`
  20 /// method can provide a `Waker`, which is a handle for waking up the current
  21 /// task.
  22 ///
  23 /// When using a future, you generally won't call `poll` directly, but instead
  24 /// `await!` the value.
  25 #[doc(spotlight)]
  26 #[must_use = "futures do nothing unless polled"]
  27 #[stable(feature = "futures_api", since = "1.36.0")]
  28 pub trait Future {
  29     /// The type of value produced on completion.
  30     #[stable(feature = "futures_api", since = "1.36.0")]
  31     type Output;
  32
  33     /// Attempt to resolve the future to a final value, registering
  34     /// the current task for wakeup if the value is not yet available.
  35     ///
  36     /// # Return value
  37     ///
  38     /// This function returns:
  39     ///
  40     /// - [`Poll::Pending`] if the future is not ready yet
  41     /// - [`Poll::Ready(val)`] with the result `val` of this future if it
  42     ///   finished successfully.
  43     ///
  44     /// Once a future has finished, clients should not `poll` it again.
  45     ///
  46     /// When a future is not ready yet, `poll` returns `Poll::Pending` and
  47     /// stores a clone of the [`Waker`] copied from the current [`Context`].
  48     /// This [`Waker`] is then woken once the future can make progress.
  49     /// For example, a future waiting for a socket to become
  50     /// readable would call `.clone()` on the [`Waker`] and store it.
  51     /// When a signal arrives elsewhere indicating that the socket is readable,
  52     /// [`Waker::wake`] is called and the socket future's task is awoken.
  53     /// Once a task has been woken up, it should attempt to `poll` the future
  54     /// again, which may or may not produce a final value.
  55     ///
  56     /// Note that on multiple calls to `poll`, only the [`Waker`] from the
  57     /// [`Context`] passed to the most recent call should be scheduled to
  58     /// receive a wakeup.
  59     ///
  60     /// # Runtime characteristics
  61     ///
  62     /// Futures alone are *inert*; they must be *actively* `poll`ed to make
  63     /// progress, meaning that each time the current task is woken up, it should
  64     /// actively re-`poll` pending futures that it still has an interest in.
  65     ///
  66     /// The `poll` function is not called repeatedly in a tight loop -- instead,
  67     /// it should only be called when the future indicates that it is ready to
  68     /// make progress (by calling `wake()`). If you're familiar with the
  69     /// `poll(2)` or `select(2)` syscalls on Unix it's worth noting that futures
  70     /// typically do *not* suffer the same problems of "all wakeups must poll
  71     /// all events"; they are more like `epoll(4)`.
  72     ///
  73     /// An implementation of `poll` should strive to return quickly, and should
  74     /// not block. Returning quickly prevents unnecessarily clogging up
  75     /// threads or event loops. If it is known ahead of time that a call to
  76     /// `poll` may end up taking awhile, the work should be offloaded to a
  77     /// thread pool (or something similar) to ensure that `poll` can return
  78     /// quickly.
  79     ///
  80     /// # Panics
  81     ///
  82     /// Once a future has completed (returned `Ready` from `poll`), calling its
  83     /// `poll` method again may panic, block forever, or cause other kinds of
  84     /// problems; the `Future` trait places no requirements on the effects of
  85     /// such a call. However, as the `poll` method is not marked `unsafe`,
  86     /// Rust's usual rules apply: calls must never cause undefined behavior
  87     /// (memory corruption, incorrect use of `unsafe` functions, or the like),
  88     /// regardless of the future's state.
  89     ///
  90     /// [`Poll::Pending`]: ../task/enum.Poll.html#variant.Pending
  91     /// [`Poll::Ready(val)`]: ../task/enum.Poll.html#variant.Ready
  92     /// [`Context`]: ../task/struct.Context.html
  93     /// [`Waker`]: ../task/struct.Waker.html
  94     /// [`Waker::wake`]: ../task/struct.Waker.html#method.wake
  95     #[stable(feature = "futures_api", since = "1.36.0")]
  96     fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>;
  97 }
  98
  99 #[stable(feature = "futures_api", since = "1.36.0")]
 100 impl<F: ?Sized + Future + Unpin> Future for &mut F {
 101     type Output = F::Output;
 102
 103     fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
 104         F::poll(Pin::new(&mut **self), cx)
 105     }
 106 }
 107
 108 #[stable(feature = "futures_api", since = "1.36.0")]
 109 impl<P> Future for Pin<P>
 110 where
 111     P: Unpin + ops::DerefMut,
 112     P::Target: Future,
 113 {
 114     type Output = <<P as ops::Deref>::Target as Future>::Output;
 115
 116     fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
 117         Pin::get_mut(self).as_mut().poll(cx)
 118     }
 119 }