Skip to content

adds stream::chain combinator #233

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 1 commit into from
Sep 22, 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
50 changes: 50 additions & 0 deletions src/stream/stream/chain.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
use std::pin::Pin;

use super::fuse::Fuse;
use crate::stream::Stream;
use crate::task::{Context, Poll};

/// Chains two streams one after another.
#[derive(Debug)]
pub struct Chain<S, U> {
first: Fuse<S>,
second: Fuse<U>,
}

impl<S: Stream, U: Stream> Chain<S, U> {
pin_utils::unsafe_pinned!(first: Fuse<S>);
pin_utils::unsafe_pinned!(second: Fuse<U>);

pub(super) fn new(first: S, second: U) -> Self {
Chain {
first: first.fuse(),
second: second.fuse(),
}
}
}

impl<S: Stream, U: Stream<Item = S::Item>> Stream for Chain<S, U> {
type Item = S::Item;

fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
if !self.first.done {
let next = futures_core::ready!(self.as_mut().first().poll_next(cx));
if let Some(next) = next {
return Poll::Ready(Some(next));
}
}

if !self.second.done {
let next = futures_core::ready!(self.as_mut().second().poll_next(cx));
if let Some(next) = next {
return Poll::Ready(Some(next));
}
}

if self.first.done && self.second.done {
return Poll::Ready(None);
}

Poll::Pending
}
}
8 changes: 5 additions & 3 deletions src/stream/stream/fuse.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
use std::pin::Pin;
use std::task::{Context, Poll};

use crate::stream::Stream;
use crate::task::{Context, Poll};

/// A `Stream` that is permanently closed once a single call to `poll` results in
/// `Poll::Ready(None)`, returning `Poll::Ready(None)` for all future calls to `poll`.
Expand All @@ -11,12 +13,12 @@ pub struct Fuse<S> {

impl<S: Unpin> Unpin for Fuse<S> {}

impl<S: futures_core::Stream> Fuse<S> {
impl<S: Stream> Fuse<S> {
pin_utils::unsafe_pinned!(stream: S);
pin_utils::unsafe_unpinned!(done: bool);
}

impl<S: futures_core::Stream> futures_core::Stream for Fuse<S> {
impl<S: Stream> Stream for Fuse<S> {
type Item = S::Item;

fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<S::Item>> {
Expand Down
35 changes: 35 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 chain;
mod enumerate;
mod filter;
mod filter_map;
Expand All @@ -41,6 +42,7 @@ mod step_by;
mod take;
mod zip;

pub use chain::Chain;
pub use filter::Filter;
pub use fuse::Fuse;
pub use inspect::Inspect;
Expand Down Expand Up @@ -268,6 +270,39 @@ pub trait Stream {
StepBy::new(self, step)
}

/// Takes two streams and creates a new stream over both in sequence.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// # fn main() { async_std::task::block_on(async {
/// #
/// use async_std::prelude::*;
/// use std::collections::VecDeque;
///
/// let first: VecDeque<_> = vec![0u8, 1].into_iter().collect();
/// let second: VecDeque<_> = vec![2, 3].into_iter().collect();
/// let mut c = first.chain(second);
///
/// assert_eq!(c.next().await, Some(0));
/// assert_eq!(c.next().await, Some(1));
/// assert_eq!(c.next().await, Some(2));
/// assert_eq!(c.next().await, Some(3));
/// assert_eq!(c.next().await, None);
///
/// #
/// # }) }
/// ```
fn chain<U>(self, other: U) -> Chain<Self, U>
where
Self: Sized,
U: Stream<Item = Self::Item> + Sized,
{
Chain::new(self, other)
}

/// Creates a stream that gives the current element's count as well as the next value.
///
/// # Overflow behaviour.
Expand Down