Skip to content

adds stream::skip combinator #222

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 3 commits into from
Sep 21, 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
27 changes: 27 additions & 0 deletions src/stream/stream/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,13 @@ mod min_by;
mod next;
mod nth;
mod scan;
mod skip;
mod take;
mod zip;

pub use fuse::Fuse;
pub use scan::Scan;
pub use skip::Skip;
pub use take::Take;
pub use zip::Zip;

Expand Down Expand Up @@ -661,6 +663,31 @@ pub trait Stream {
Scan::new(self, initial_state, f)
}

/// Creates a combinator that skips the first `n` elements.
///
/// ## Examples
///
/// ```
/// # fn main() { async_std::task::block_on(async {
/// #
/// use std::collections::VecDeque;
/// use async_std::stream::Stream;
///
/// let s: VecDeque<usize> = vec![1, 2, 3].into_iter().collect();
/// let mut skipped = s.skip(2);
///
/// assert_eq!(skipped.next().await, Some(3));
/// assert_eq!(skipped.next().await, None);
/// #
/// # }) }
/// ```
fn skip(self, n: usize) -> Skip<Self>
where
Self: Sized,
{
Skip::new(self, n)
}

/// 'Zips up' two streams into a single stream of pairs.
///
/// `zip()` returns a new stream that will iterate over two other streams, returning a tuple
Expand Down
41 changes: 41 additions & 0 deletions src/stream/stream/skip.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
use std::pin::Pin;
use std::task::{Context, Poll};

use crate::stream::Stream;

/// A stream to skip first n elements of another stream.
#[derive(Debug)]
pub struct Skip<S> {
stream: S,
n: usize,
}

impl<S> Skip<S> {
pin_utils::unsafe_pinned!(stream: S);
pin_utils::unsafe_unpinned!(n: usize);

pub(crate) fn new(stream: S, n: usize) -> Self {
Skip { stream, n }
}
}

impl<S> Stream for Skip<S>
where
S: Stream,
{
type Item = S::Item;

fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
loop {
let next = futures_core::ready!(self.as_mut().stream().poll_next(cx));

match next {
Some(v) => match self.n {
0 => return Poll::Ready(Some(v)),
_ => *self.as_mut().n() -= 1,
},
None => return Poll::Ready(None),
}
}
}
}