summaryrefslogtreecommitdiffstats
path: root/tokio-futures/src/stream/mod.rs
blob: a6d987d6156a66a975710d573e9fc7a85015ce32 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
//! Use streams with `async` / `await`.

mod next;

pub use self::next::Next;

use futures::Stream;

/// An extension trait which adds utility methods to `Stream` types.
pub trait StreamExt: Stream {
    /// Creates a future that resolves to the next item in the stream.
    ///
    /// # Examples
    ///
    /// ```edition2018
    /// #![feature(async_await)]
    /// tokio::run_async(async {
    /// // The extension trait can also be imported with
    /// // `use tokio::prelude::*`.
    /// use tokio::prelude::{stream, StreamAsyncExt};
    ///
    /// let mut stream = stream::iter_ok::<_, ()>(1..3);
    ///
    /// assert_eq!(stream.next().await, Some(Ok(1)));
    /// assert_eq!(stream.next().await, Some(Ok(2)));
    /// assert_eq!(stream.next().await, Some(Ok(3)));
    /// assert_eq!(stream.next().await, None);
    /// });
    /// ```
    fn next(&mut self) -> Next<'_, Self>
    where
        Self: Sized + Unpin,
    {
        Next::new(self)
    }
}

impl<T: Stream> StreamExt for T {}