library/core/src/future/mod.rs

   1 #![stable(feature = "futures_api", since = "1.36.0")]
   2
   3 //! Asynchronous basic functionality.
   4 //!
   5 //! Please see the fundamental [`async`] and [`await`] keywords and the [async book]
   6 //! for more information on asynchronous programming in Rust.
   7 //!
   8 //! [`async`]: ../../std/keyword.async.html
   9 //! [`await`]: ../../std/keyword.await.html
  10 //! [async book]: https://rust-lang.github.io/async-book/
  11
  12 use crate::ptr::NonNull;
  13 use crate::task::Context;
  14
  15 mod future;
  16 mod into_future;
  17 mod join;
  18 mod pending;
  19 mod poll_fn;
  20 mod ready;
  21
  22 #[stable(feature = "futures_api", since = "1.36.0")]
  23 pub use self::future::Future;
  24
  25 #[unstable(feature = "future_join", issue = "91642")]
  26 pub use self::join::join;
  27
  28 #[stable(feature = "into_future", since = "1.64.0")]
  29 pub use into_future::IntoFuture;
  30
  31 #[stable(feature = "future_readiness_fns", since = "1.48.0")]
  32 pub use pending::{pending, Pending};
  33 #[stable(feature = "future_readiness_fns", since = "1.48.0")]
  34 pub use ready::{ready, Ready};
  35
  36 #[stable(feature = "future_poll_fn", since = "1.64.0")]
  37 pub use poll_fn::{poll_fn, PollFn};
  38
  39 /// This type is needed because:
  40 ///
  41 /// a) Generators cannot implement `for<'a, 'b> Generator<&'a mut Context<'b>>`, so we need to pass
  42 ///    a raw pointer (see <https://github.com/rust-lang/rust/issues/68923>).
  43 /// b) Raw pointers and `NonNull` aren't `Send` or `Sync`, so that would make every single future
  44 ///    non-Send/Sync as well, and we don't want that.
  45 ///
  46 /// It also simplifies the HIR lowering of `.await`.
  47 #[cfg_attr(not(bootstrap), lang = "ResumeTy")]
  48 #[doc(hidden)]
  49 #[unstable(feature = "gen_future", issue = "50547")]
  50 #[derive(Debug, Copy, Clone)]
  51 pub struct ResumeTy(NonNull<Context<'static>>);
  52
  53 #[unstable(feature = "gen_future", issue = "50547")]
  54 unsafe impl Send for ResumeTy {}
  55
  56 #[unstable(feature = "gen_future", issue = "50547")]
  57 unsafe impl Sync for ResumeTy {}
  58
  59 /// Wrap a generator in a future.
  60 ///
  61 /// This function returns a `GenFuture` underneath, but hides it in `impl Trait` to give
  62 /// better error messages (`impl Future` rather than `GenFuture<[closure.....]>`).
  63 // This is `const` to avoid extra errors after we recover from `const async fn`
  64 #[cfg_attr(bootstrap, lang = "from_generator")]
  65 #[doc(hidden)]
  66 #[unstable(feature = "gen_future", issue = "50547")]
  67 #[rustc_const_unstable(feature = "gen_future", issue = "50547")]
  68 #[inline]
  69 pub const fn from_generator<T>(gen: T) -> impl Future<Output = T::Return>
  70 where
  71     T: crate::ops::Generator<ResumeTy, Yield = ()>,
  72 {
  73     use crate::{
  74         ops::{Generator, GeneratorState},
  75         pin::Pin,
  76         task::Poll,
  77     };
  78
  79     #[rustc_diagnostic_item = "gen_future"]
  80     struct GenFuture<T: Generator<ResumeTy, Yield = ()>>(T);
  81
  82     // We rely on the fact that async/await futures are immovable in order to create
  83     // self-referential borrows in the underlying generator.
  84     impl<T: Generator<ResumeTy, Yield = ()>> !Unpin for GenFuture<T> {}
  85
  86     impl<T: Generator<ResumeTy, Yield = ()>> Future for GenFuture<T> {
  87         type Output = T::Return;
  88         #[track_caller]
  89         fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
  90             // SAFETY: Safe because we're !Unpin + !Drop, and this is just a field projection.
  91             let gen = unsafe { Pin::map_unchecked_mut(self, |s| &mut s.0) };
  92
  93             // Resume the generator, turning the `&mut Context` into a `NonNull` raw pointer. The
  94             // `.await` lowering will safely cast that back to a `&mut Context`.
  95             match gen.resume(ResumeTy(NonNull::from(cx).cast::<Context<'static>>())) {
  96                 GeneratorState::Yielded(()) => Poll::Pending,
  97                 GeneratorState::Complete(x) => Poll::Ready(x),
  98             }
  99         }
 100     }
 101
 102     GenFuture(gen)
 103 }
 104
 105 #[lang = "get_context"]
 106 #[doc(hidden)]
 107 #[unstable(feature = "gen_future", issue = "50547")]
 108 #[must_use]
 109 #[inline]
 110 pub unsafe fn get_context<'a, 'b>(cx: ResumeTy) -> &'a mut Context<'b> {
 111     // SAFETY: the caller must guarantee that `cx.0` is a valid pointer
 112     // that fulfills all the requirements for a mutable reference.
 113     unsafe { &mut *cx.0.as_ptr().cast() }
 114 }
 115
 116 #[cfg_attr(not(bootstrap), lang = "identity_future")]
 117 #[doc(hidden)]
 118 #[unstable(feature = "gen_future", issue = "50547")]
 119 #[inline]
 120 pub const fn identity_future<O, Fut: Future<Output = O>>(f: Fut) -> Fut {
 121     f
 122 }