Merge pull request #128 from yoshuawuyts/ext-traits

Add extension traits

Author: yoshuawuyts

src/future/futures_ext.rs

@@ -0,0 +1,43 @@
+use crate::future::Join;
+use crate::future::Race;
+use futures_core::Future;
+use std::future::IntoFuture;
+
+use super::join::tuple::Join2;
+use super::race::tuple::Race2;
+
+/// An extension trait for the `Future` trait.
+pub trait FutureExt: Future {
+    /// Wait for both futures to complete.
+    fn join<S2>(self, other: S2) -> Join2<Self, S2::IntoFuture>
+    where
+        Self: Future + Sized,
+        S2: IntoFuture;
+
+    /// Wait for the first future to complete.
+    fn race<T, S2>(self, other: S2) -> Race2<T, Self, S2::IntoFuture>
+    where
+        Self: Future<Output = T> + Sized,
+        S2: IntoFuture<Output = T>;
+}
+
+impl<F1> FutureExt for F1
+where
+    F1: Future,
+{
+    fn join<F2>(self, other: F2) -> Join2<Self, F2::IntoFuture>
+    where
+        Self: Future + Sized,
+        F2: IntoFuture,
+    {
+        Join::join((self, other))
+    }
+
+    fn race<T, S2>(self, other: S2) -> Race2<T, Self, S2::IntoFuture>
+    where
+        Self: Future<Output = T> + Sized,
+        S2: IntoFuture<Output = T>,
+    {
+        Race::race((self, other))
+    }
+}

src/future/mod.rs

@@ -68,11 +68,13 @@
 //! - `future::RaceOk`: wait for the first _successful_ future in the set to
 //! complete, or return an `Err` if *no* futures complete successfully.
 //!
+pub use futures_ext::FutureExt;
 pub use join::Join;
 pub use race::Race;
 pub use race_ok::RaceOk;
 pub use try_join::TryJoin;
 
+mod futures_ext;
 pub(crate) mod join;
 pub(crate) mod race;
 pub(crate) mod race_ok;

src/lib.rs

@@ -66,6 +66,9 @@ mod utils;
 
 /// The futures concurrency prelude.
 pub mod prelude {
+    pub use super::future::FutureExt as _;
+    pub use super::stream::StreamExt as _;
+
     pub use super::future::Join as _;
     pub use super::future::Race as _;
     pub use super::future::RaceOk as _;

src/stream/mod.rs

@@ -50,9 +50,11 @@
 pub use chain::Chain;
 pub use into_stream::IntoStream;
 pub use merge::Merge;
+pub use stream_ext::StreamExt;
 pub use zip::Zip;
 
 pub(crate) mod chain;
 mod into_stream;
 pub(crate) mod merge;
+mod stream_ext;
 pub(crate) mod zip;

src/stream/stream_ext.rs

@@ -0,0 +1,56 @@
+use crate::stream::{IntoStream, Merge};
+use futures_core::Stream;
+
+use super::{chain::tuple::Chain2, merge::tuple::Merge2, zip::tuple::Zip2, Chain, Zip};
+
+/// An extension trait for the `Stream` trait.
+pub trait StreamExt: Stream {
+    /// Combines two streams into a single stream of all their outputs.
+    fn merge<T, S2>(self, other: S2) -> Merge2<T, Self, S2::IntoStream>
+    where
+        Self: Stream<Item = T> + Sized,
+        S2: IntoStream<Item = T>;
+
+    /// Takes two streams and creates a new stream over all in sequence
+    fn chain<T, S2>(self, other: S2) -> Chain2<Self, S2::IntoStream>
+    where
+        Self: Stream<Item = T> + Sized,
+        S2: IntoStream<Item = T>;
+
+    /// ‘Zips up’ multiple streams into a single stream of pairs.
+    fn zip<T, S2>(self, other: S2) -> Zip2<Self, S2::IntoStream>
+    where
+        Self: Stream<Item = T> + Sized,
+        S2: IntoStream<Item = T>;
+}
+
+impl<S1> StreamExt for S1
+where
+    S1: Stream,
+{
+    fn merge<T, S2>(self, other: S2) -> Merge2<T, S1, S2::IntoStream>
+    where
+        S1: Stream<Item = T>,
+        S2: IntoStream<Item = T>,
+    {
+        Merge::merge((self, other))
+    }
+
+    fn chain<T, S2>(self, other: S2) -> Chain2<Self, S2::IntoStream>
+    where
+        Self: Stream<Item = T> + Sized,
+        S2: IntoStream<Item = T>,
+    {
+        // TODO(yosh): fix the bounds on the tuple impl
+        Chain::chain((self, other.into_stream()))
+    }
+
+    fn zip<T, S2>(self, other: S2) -> Zip2<Self, S2::IntoStream>
+    where
+        Self: Stream<Item = T> + Sized,
+        S2: IntoStream<Item = T>,
+    {
+        // TODO(yosh): fix the bounds on the tuple impl
+        Zip::zip((self, other.into_stream()))
+    }
+}