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
use core::{
future::Future,
pin::Pin,
task::{Context, Poll},
};
use futures_core::Stream;
use pin_project_lite::pin_project;
use crate::FuturesUnorderedBounded;
pin_project!(
/// Stream for the [`buffered_unordered`](crate::BufferedStreamExt::buffered_unordered)
/// method.
///
/// # Examples
///
/// ```
/// # futures::executor::block_on(async {
/// use futures::channel::oneshot;
/// use futures::stream::{self, StreamExt};
/// use futures_buffered::BufferedStreamExt;
///
/// let (send_one, recv_one) = oneshot::channel();
/// let (send_two, recv_two) = oneshot::channel();
///
/// let stream_of_futures = stream::iter(vec![recv_one, recv_two]);
/// let mut buffered = stream_of_futures.buffered_unordered(10);
///
/// send_two.send(2i32)?;
/// assert_eq!(buffered.next().await, Some(Ok(2i32)));
///
/// send_one.send(1i32)?;
/// assert_eq!(buffered.next().await, Some(Ok(1i32)));
///
/// assert_eq!(buffered.next().await, None);
/// # Ok::<(), i32>(()) }).unwrap();
/// ```
///
/// ## Benchmarks
///
/// ### Speed
///
/// Running 65536 100us timers with 256 concurrent jobs in a single threaded tokio runtime:
///
/// ```text
/// futures::stream::BufferUnordered time: [420.33 ms 422.57 ms 424.83 ms]
/// futures_buffered::BufferUnordered time: [363.39 ms 365.59 ms 367.78 ms]
/// ```
///
/// ### Memory usage
///
/// Running 512000 `Ready<i32>` futures with 256 concurrent jobs.
///
/// - count: the number of times alloc/dealloc was called
/// - alloc: the number of cumulative bytes allocated
/// - dealloc: the number of cumulative bytes deallocated
///
/// ```text
/// futures::stream::BufferUnordered
/// count: 1024002
/// alloc: 40960144 B
/// dealloc: 40960000 B
///
/// futures_buffered::BufferUnordered
/// count: 2
/// alloc: 8264 B
/// dealloc: 0 B
/// ```
#[must_use = "streams do nothing unless polled"]
pub struct BufferUnordered<S: Stream> {
#[pin]
pub(crate) stream: Option<S>,
pub(crate) in_progress_queue: FuturesUnorderedBounded<S::Item>,
}
);
impl<St> Stream for BufferUnordered<St>
where
St: Stream,
St::Item: Future,
{
type Item = <St::Item as Future>::Output;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let mut this = self.project();
// First up, try to spawn off as many futures as possible by filling up
// our queue of futures.
let unordered = this.in_progress_queue;
while unordered.tasks.len() < unordered.tasks.capacity() {
if let Some(s) = this.stream.as_mut().as_pin_mut() {
match s.poll_next(cx) {
Poll::Ready(Some(fut)) => {
unordered.push(fut);
continue;
}
Poll::Ready(None) => this.stream.as_mut().set(None),
Poll::Pending => {}
}
}
break;
}
// Attempt to pull the next value from the in_progress_queue
match Pin::new(unordered).poll_next(cx) {
x @ (Poll::Pending | Poll::Ready(Some(_))) => return x,
Poll::Ready(None) => {}
}
// If more values are still coming from the stream, we're not done yet
if this.stream.as_pin_mut().is_none() {
Poll::Ready(None)
} else {
Poll::Pending
}
}
fn size_hint(&self) -> (usize, Option<usize>) {
match &self.stream {
Some(s) => {
let queue_len = self.in_progress_queue.len();
let (lower, upper) = s.size_hint();
let lower = lower.saturating_add(queue_len);
let upper = match upper {
Some(x) => x.checked_add(queue_len),
None => None,
};
(lower, upper)
}
_ => (0, Some(0)),
}
}
}
#[cfg(test)]
mod tests {
use crate::BufferedStreamExt;
use super::*;
use futures::{channel::oneshot, stream, StreamExt};
use futures_test::task::noop_context;
#[test]
fn buffered_unordered() {
let (send_one, recv_one) = oneshot::channel();
let (send_two, recv_two) = oneshot::channel();
let stream_of_futures = stream::iter(vec![recv_one, recv_two]);
let mut buffered = stream_of_futures.buffered_unordered(10);
let mut cx = noop_context();
// sized properly
assert_eq!(buffered.size_hint(), (2, Some(2)));
// make sure it returns pending
assert_eq!(buffered.poll_next_unpin(&mut cx), Poll::Pending);
// returns in any order
send_two.send(2i32).unwrap();
assert_eq!(
buffered.poll_next_unpin(&mut cx),
Poll::Ready(Some(Ok(2i32)))
);
send_one.send(1i32).unwrap();
assert_eq!(
buffered.poll_next_unpin(&mut cx),
Poll::Ready(Some(Ok(1i32)))
);
// completes properly
assert_eq!(buffered.poll_next_unpin(&mut cx), Poll::Ready(None));
}
}