Skip to content
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

adds stream::filter_map combinator #163

Merged
merged 2 commits into from
Sep 10, 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
48 changes: 48 additions & 0 deletions src/stream/stream/filter_map.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
use std::marker::PhantomData;
use std::pin::Pin;
use std::task::{Context, Poll};

/// A stream that both filters and maps.
#[derive(Clone, Debug)]
pub struct FilterMap<S, F, T, B> {
stream: S,
f: F,
__from: PhantomData<T>,
__to: PhantomData<B>,
}

impl<S, F, T, B> FilterMap<S, F, T, B> {
pin_utils::unsafe_pinned!(stream: S);
pin_utils::unsafe_unpinned!(f: F);

pub(crate) fn new(stream: S, f: F) -> Self {
FilterMap {
stream,
f,
__from: PhantomData,
__to: PhantomData,
}
}
}

impl<S, F, B> futures_core::stream::Stream for FilterMap<S, F, S::Item, B>
where
S: futures_core::stream::Stream,
F: FnMut(S::Item) -> Option<B>,
{
type Item = B;

fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let next = futures_core::ready!(self.as_mut().stream().poll_next(cx));
match next {
Some(v) => match (self.as_mut().f())(v) {
Some(b) => Poll::Ready(Some(b)),
None => {
cx.waker().wake_by_ref();
Poll::Pending
}
},
None => Poll::Ready(None),
}
}
}
39 changes: 39 additions & 0 deletions src/stream/stream/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@

mod all;
mod any;
mod filter_map;
mod min_by;
mod next;
mod take;
Expand All @@ -31,6 +32,7 @@ pub use take::Take;

use all::AllFuture;
use any::AnyFuture;
use filter_map::FilterMap;
use min_by::MinByFuture;
use next::NextFuture;

Expand Down Expand Up @@ -128,6 +130,43 @@ pub trait Stream {
}
}

/// Both filters and maps a stream.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// # fn main() { async_std::task::block_on(async {
/// #
/// use std::collections::VecDeque;
/// use async_std::stream::Stream;
///
/// let s: VecDeque<&str> = vec!["1", "lol", "3", "NaN", "5"].into_iter().collect();
///
/// let mut parsed = s.filter_map(|a| a.parse::<u32>().ok());
///
/// let one = parsed.next().await;
/// assert_eq!(one, Some(1));
///
/// let three = parsed.next().await;
/// assert_eq!(three, Some(3));
///
/// let five = parsed.next().await;
/// assert_eq!(five, Some(5));
///
/// let end = parsed.next().await;
/// assert_eq!(end, None);
/// #
/// # }) }
fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F, Self::Item, B>
where
Self: Sized,
F: FnMut(Self::Item) -> Option<B>,
{
FilterMap::new(self, f)
}

/// Returns the element that gives the minimum value with respect to the
/// specified comparison function. If several elements are equally minimum,
/// the first element is returned. If the stream is empty, `None` is returned.
Expand Down