1 #![stable(feature = "futures_api", since = "1.36.0")]
3 //! Asynchronous basic functionality.
5 //! Please see the fundamental [`async`] and [`await`] keywords and the [async book]
6 //! for more information on asynchronous programming in Rust.
8 //! [`async`]: ../../std/keyword.async.html
9 //! [`await`]: ../../std/keyword.await.html
10 //! [async book]: https://rust-lang.github.io/async-book/
12 use crate::ptr::NonNull;
13 use crate::task::Context;
22 #[stable(feature = "futures_api", since = "1.36.0")]
23 pub use self::future::Future;
25 #[unstable(feature = "future_join", issue = "91642")]
26 pub use self::join::join;
28 #[stable(feature = "into_future", since = "1.64.0")]
29 pub use into_future::IntoFuture;
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};
36 #[stable(feature = "future_poll_fn", since = "1.64.0")]
37 pub use poll_fn::{poll_fn, PollFn};
39 /// This type is needed because:
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.
46 /// It also simplifies the HIR lowering of `.await`.
49 #[unstable(feature = "gen_future", issue = "50547")]
50 #[derive(Debug, Copy, Clone)]
51 pub struct ResumeTy(NonNull<Context<'static>>);
53 #[unstable(feature = "gen_future", issue = "50547")]
54 unsafe impl Send for ResumeTy {}
56 #[unstable(feature = "gen_future", issue = "50547")]
57 unsafe impl Sync for ResumeTy {}
59 /// Wrap a generator in a future.
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`
65 #[unstable(feature = "gen_future", issue = "50547")]
66 #[rustc_const_unstable(feature = "gen_future", issue = "50547")]
68 pub const fn from_generator<T>(gen: T) -> impl Future<Output = T::Return>
70 T: crate::ops::Generator<ResumeTy, Yield = ()>,
73 ops::{Generator, GeneratorState},
78 #[rustc_diagnostic_item = "gen_future"]
79 struct GenFuture<T: Generator<ResumeTy, Yield = ()>>(T);
81 // We rely on the fact that async/await futures are immovable in order to create
82 // self-referential borrows in the underlying generator.
83 impl<T: Generator<ResumeTy, Yield = ()>> !Unpin for GenFuture<T> {}
85 impl<T: Generator<ResumeTy, Yield = ()>> Future for GenFuture<T> {
86 type Output = T::Return;
88 fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
89 // SAFETY: Safe because we're !Unpin + !Drop, and this is just a field projection.
90 let gen = unsafe { Pin::map_unchecked_mut(self, |s| &mut s.0) };
92 // Resume the generator, turning the `&mut Context` into a `NonNull` raw pointer. The
93 // `.await` lowering will safely cast that back to a `&mut Context`.
94 match gen.resume(ResumeTy(NonNull::from(cx).cast::<Context<'static>>())) {
95 GeneratorState::Yielded(()) => Poll::Pending,
96 GeneratorState::Complete(x) => Poll::Ready(x),
104 #[lang = "get_context"]
106 #[unstable(feature = "gen_future", issue = "50547")]
109 pub unsafe fn get_context<'a, 'b>(cx: ResumeTy) -> &'a mut Context<'b> {
110 // SAFETY: the caller must guarantee that `cx.0` is a valid pointer
111 // that fulfills all the requirements for a mutable reference.
112 unsafe { &mut *cx.0.as_ptr().cast() }
116 #[unstable(feature = "gen_future", issue = "50547")]
118 #[lang = "identity_future"]
119 pub const fn identity_future<O, Fut: Future<Output = O>>(f: Fut) -> Fut {