1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
use super::Join as JoinTrait;
use crate::utils::{self, PollArray};
use core::array;
use core::fmt;
use core::future::{Future, IntoFuture};
use core::mem::{self, MaybeUninit};
use core::pin::Pin;
use core::task::{Context, Poll};
use pin_project::{pin_project, pinned_drop};
#[must_use = "futures do nothing unless you `.await` or poll them"]
#[pin_project(PinnedDrop)]
pub struct Join<Fut, const N: usize>
where
Fut: Future,
{
consumed: bool,
pending: usize,
items: [MaybeUninit<<Fut as Future>::Output>; N],
state: PollArray<N>,
#[pin]
futures: [Fut; N],
}
impl<Fut, const N: usize> Join<Fut, N>
where
Fut: Future,
{
#[inline]
pub(crate) fn new(futures: [Fut; N]) -> Self {
Join {
consumed: false,
pending: N,
items: array::from_fn(|_| MaybeUninit::uninit()),
state: PollArray::new(),
futures,
}
}
}
impl<Fut, const N: usize> JoinTrait for [Fut; N]
where
Fut: IntoFuture,
{
type Output = [Fut::Output; N];
type Future = Join<Fut::IntoFuture, N>;
#[inline]
fn join(self) -> Self::Future {
Join::new(self.map(IntoFuture::into_future))
}
}
impl<Fut, const N: usize> fmt::Debug for Join<Fut, N>
where
Fut: Future + fmt::Debug,
Fut::Output: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_list().entries(self.state.iter()).finish()
}
}
impl<Fut, const N: usize> Future for Join<Fut, N>
where
Fut: Future,
{
type Output = [Fut::Output; N];
#[inline]
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let mut this = self.project();
assert!(
!*this.consumed,
"Futures must not be polled after completing"
);
for (i, fut) in utils::iter_pin_mut(this.futures.as_mut()).enumerate() {
if this.state[i].is_pending() {
if let Poll::Ready(value) = fut.poll(cx) {
this.items[i] = MaybeUninit::new(value);
this.state[i].set_ready();
*this.pending -= 1;
}
}
}
if *this.pending == 0 {
*this.consumed = true;
for state in this.state.iter_mut() {
debug_assert!(
state.is_ready(),
"Future should have reached a `Ready` state"
);
state.set_consumed();
}
let mut items = array::from_fn(|_| MaybeUninit::uninit());
mem::swap(this.items, &mut items);
let items = unsafe { utils::array_assume_init(items) };
Poll::Ready(items)
} else {
Poll::Pending
}
}
}
#[pinned_drop]
impl<Fut, const N: usize> PinnedDrop for Join<Fut, N>
where
Fut: Future,
{
fn drop(self: Pin<&mut Self>) {
let this = self.project();
let indexes = this
.state
.iter_mut()
.enumerate()
.filter(|(_, state)| state.is_ready())
.map(|(i, _)| i);
for i in indexes {
unsafe { this.items[i].assume_init_drop() };
}
}
}
#[cfg(test)]
mod test {
use super::*;
use crate::utils::DummyWaker;
use std::future;
use std::future::Future;
use std::sync::Arc;
use std::task::Context;
#[test]
fn smoke() {
futures_lite::future::block_on(async {
let fut = [future::ready("hello"), future::ready("world")].join();
assert_eq!(fut.await, ["hello", "world"]);
});
}
#[test]
fn debug() {
let mut fut = [future::ready("hello"), future::ready("world")].join();
assert_eq!(format!("{:?}", fut), "[Pending, Pending]");
let mut fut = Pin::new(&mut fut);
let waker = Arc::new(DummyWaker()).into();
let mut cx = Context::from_waker(&waker);
let _ = fut.as_mut().poll(&mut cx);
assert_eq!(format!("{:?}", fut), "[Consumed, Consumed]");
}
}