Skip to content

Added the ability to collect a stream of results #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ pub mod io;
pub mod net;
pub mod os;
pub mod prelude;
mod result;
pub mod stream;
pub mod sync;
pub mod task;
Expand Down
47 changes: 47 additions & 0 deletions src/result/from_stream.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
use crate::stream::{FromStream, IntoStream, Stream};

use std::pin::Pin;

impl<T: Send, E: Send, V> FromStream<Result<T, E>> for Result<V, E>
where
V: FromStream<T>,
{
/// Takes each element in the stream: if it is an `Err`, no further
/// elements are taken, and the `Err` is returned. Should no `Err`
/// occur, a container with the values of each `Result` is returned.
#[inline]
fn from_stream<'a, S: IntoStream<Item = Result<T, E>>>(
stream: S,
) -> Pin<Box<dyn core::future::Future<Output = Self> + Send + 'a>>
where
<S as IntoStream>::IntoStream: Send + 'a,
{
let stream = stream.into_stream();

Pin::from(Box::new(async move {
pin_utils::pin_mut!(stream);

// Using `scan` here because it is able to stop the stream early
// if a failure occurs
let mut found_error = None;
let out: V = stream
.scan((), |_, elem| {
match elem {
Ok(elem) => Some(elem),
Err(err) => {
found_error = Some(err);
// Stop processing the stream on error
None
}
}
})
.collect()
.await;

match found_error {
Some(err) => Err(err),
None => Ok(out),
}
}))
}
}
9 changes: 9 additions & 0 deletions src/result/mod.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
//! The Rust core error handling type
//!
//! This module provides the `Result<T, E>` type for returning and
//! propagating errors.

mod from_stream;

#[doc(inline)]
pub use std::result::Result;
16 changes: 16 additions & 0 deletions src/stream/stream/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -695,6 +695,22 @@ pub trait Stream {
/// let buf: Vec<u8> = s.collect().await;
///
/// assert_eq!(buf, vec![9; 3]);
///
/// // You can also collect streams of Result values
/// // into any collection that implements FromStream
/// let s = stream::repeat(Ok(9)).take(3);
/// // We are using Vec here, but other collections
/// // are supported as well
/// let buf: Result<Vec<u8>, ()> = s.collect().await;
///
/// assert_eq!(buf, Ok(vec![9; 3]));
///
/// // The stream will stop on the first Err and
/// // return that instead
/// let s = stream::repeat(Err(5)).take(3);
/// let buf: Result<Vec<u8>, u8> = s.collect().await;
///
/// assert_eq!(buf, Err(5));
/// #
/// # }) }
/// ```
Expand Down