summaryrefslogtreecommitdiffstats
path: root/futures/src/stream.rs
diff options
context:
space:
mode:
Diffstat (limited to 'futures/src/stream.rs')
-rw-r--r--futures/src/stream.rs46
1 files changed, 46 insertions, 0 deletions
diff --git a/futures/src/stream.rs b/futures/src/stream.rs
new file mode 100644
index 00000000..af2f8c99
--- /dev/null
+++ b/futures/src/stream.rs
@@ -0,0 +1,46 @@
+//! Create asynchronous streams of data.
+use futures::channel::mpsc;
+use futures::stream::{self, Stream, StreamExt};
+
+use std::future::Future;
+
+/// Creates a new [`Stream`] that produces the items sent from a [`Future`]
+/// to the [`mpsc::Sender`] provided to the closure.
+///
+/// This is a more ergonomic [`stream::unfold`], which allows you to go
+/// from the "world of futures" to the "world of streams" by simply looping
+/// and publishing to an async channel from inside a [`Future`].
+pub fn channel<T, F>(
+ size: usize,
+ f: impl FnOnce(mpsc::Sender<T>) -> F,
+) -> impl Stream<Item = T>
+where
+ F: Future<Output = ()>,
+{
+ let (sender, receiver) = mpsc::channel(size);
+
+ let runner = stream::once(f(sender)).filter_map(|_| async { None });
+
+ stream::select(receiver, runner)
+}
+
+/// Creates a new [`Stream`] that produces the items sent from a [`Future`]
+/// that can fail to the [`mpsc::Sender`] provided to the closure.
+pub fn try_channel<T, E, F>(
+ size: usize,
+ f: impl FnOnce(mpsc::Sender<T>) -> F,
+) -> impl Stream<Item = Result<T, E>>
+where
+ F: Future<Output = Result<(), E>>,
+{
+ let (sender, receiver) = mpsc::channel(size);
+
+ let runner = stream::once(f(sender)).filter_map(|result| async {
+ match result {
+ Ok(()) => None,
+ Err(error) => Some(Err(error)),
+ }
+ });
+
+ stream::select(receiver.map(Ok), runner)
+}