Skip to content

Add stream position #428

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
Oct 31, 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
41 changes: 41 additions & 0 deletions src/stream/stream/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ mod min_by_key;
mod next;
mod nth;
mod partial_cmp;
mod position;
mod scan;
mod skip;
mod skip_while;
Expand Down Expand Up @@ -76,6 +77,7 @@ use min_by_key::MinByKeyFuture;
use next::NextFuture;
use nth::NthFuture;
use partial_cmp::PartialCmpFuture;
use position::PositionFuture;
use try_fold::TryFoldFuture;
use try_for_each::TryForEeachFuture;

Expand Down Expand Up @@ -1548,6 +1550,45 @@ extension_trait! {
PartialCmpFuture::new(self, other)
}

#[doc = r#"
Searches for an element in a Stream that satisfies a predicate, returning
its index.

# Examples

```
# fn main() { async_std::task::block_on(async {
#
use async_std::prelude::*;
use std::collections::VecDeque;

let s: VecDeque<usize> = vec![1, 2, 3].into_iter().collect();
let res = s.clone().position(|x| *x == 1).await;
assert_eq!(res, Some(0));

let res = s.clone().position(|x| *x == 2).await;
assert_eq!(res, Some(1));

let res = s.clone().position(|x| *x == 3).await;
assert_eq!(res, Some(2));

let res = s.clone().position(|x| *x == 4).await;
assert_eq!(res, None);
#
# }) }
```
"#]
fn position<P>(
self,
predicate: P
) -> impl Future<Output = Option<usize>> [PositionFuture<Self, P>]
where
Self: Sized,
P: FnMut(&Self::Item) -> bool,
{
PositionFuture::new(self, predicate)
}

#[doc = r#"
Lexicographically compares the elements of this `Stream` with those
of another using 'Ord'.
Expand Down
51 changes: 51 additions & 0 deletions src/stream/stream/position.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
use std::pin::Pin;

use pin_project_lite::pin_project;

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

pin_project! {
#[doc(hidden)]
#[allow(missing_debug_implementations)]
pub struct PositionFuture<S, P> {
#[pin]
stream: S,
predicate: P,
index:usize,
}
}

impl<S, P> PositionFuture<S, P> {
pub(super) fn new(stream: S, predicate: P) -> Self {
PositionFuture {
stream,
predicate,
index: 0,
}
}
}

impl<S, P> Future for PositionFuture<S, P>
where
S: Stream,
P: FnMut(&S::Item) -> bool,
{
type Output = Option<usize>;

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let this = self.project();
let next = futures_core::ready!(this.stream.poll_next(cx));

match next {
Some(v) if (this.predicate)(&v) => Poll::Ready(Some(*this.index)),
Some(_) => {
cx.waker().wake_by_ref();
*this.index += 1;
Poll::Pending
}
None => Poll::Ready(None),
}
}
}