add stream::peekable

peek() implementation is still missing

Author: starsheriff

src/stream/stream/mod.rs

@@ -44,6 +44,7 @@ mod min_by;
 mod next;
 mod nth;
 mod partial_cmp;
+mod peekable;
 mod scan;
 mod skip;
 mod skip_while;
@@ -80,6 +81,7 @@ pub use filter::Filter;
 pub use fuse::Fuse;
 pub use inspect::Inspect;
 pub use map::Map;
+pub use peekable::Peekable;
 pub use scan::Scan;
 pub use skip::Skip;
 pub use skip_while::SkipWhile;
@@ -984,6 +986,37 @@ extension_trait! {
             }
         }
 
+        #[doc = r#"
+            ## Examples
+
+            ```
+            # fn main() { async_std::task::block_on(async {
+            #
+            use std::collections::VecDeque;
+
+            use async_std::prelude::*;
+
+            let s: VecDeque<usize> = vec![1, 2, 3].into_iter().collect();
+            let mut s = s.peekable();
+
+            assert_eq!(s.next().await, Some(1));
+            assert_eq!(s.peek().await, Some(1));
+            assert_eq!(s.next().await, Some(2));
+            assert_eq!(s.next().await, Some(3));
+            assert_eq!(s.next().await, None);
+            #
+            # }) }
+            ```
+        "#]
+        #[inline]
+        fn peekable(self) -> Peekable<Self>
+        where
+            Self: Sized,
+        {
+            Peekable::new(self)
+        }
+
+
         #[doc = r#"
             A stream adaptor similar to [`fold`] that holds internal state and produces a new
             stream.

src/stream/stream/peekable.rs

@@ -0,0 +1,49 @@
+use std::pin::Pin;
+
+use crate::stream::Stream;
+use crate::task::{Context, Poll};
+
+#[doc(hidden)]
+#[allow(missing_debug_implementations)]
+pub struct Peekable<S: Stream> {
+    stream: S,
+    peeked: Option<Option<S::Item>>,
+}
+
+
+impl<S> Peekable<S>
+where
+    S: Stream,
+{
+    pin_utils::unsafe_pinned!(stream: S);
+    pin_utils::unsafe_unpinned!(peeked: Option<Option<S::Item>>);
+
+    pub(crate) fn new(stream: S) -> Self {
+        Peekable{
+            stream: stream,
+            peeked: None,
+        }
+    }
+
+    pub fn peek(&mut self) -> Poll<Option<&S::Item>> {
+        Poll::Ready(None)
+    }
+
+}
+
+impl<S> Stream for Peekable<S>
+where
+    S: Stream,
+{
+    type Item = S::Item;
+
+    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+        match &self.peeked {
+            Some(_) =>  Poll::Ready(self.as_mut().peeked().take().unwrap()) ,
+            None => {
+                let next = futures_core::ready!(self.as_mut().stream().poll_next(cx));
+                Poll::Ready(next)
+            }
+        }
+    }
+}