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
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
use core::pin::Pin;
use futures_core::ready;
use futures_core::stream::{FusedStream, Stream, TryStream};
use futures_core::task::{Context, Poll};
use pin_project::{pin_project, project};

impl<S: ?Sized + TryStream> TryStreamExt for S {}

/// An extension trait for Streams that provides a variety of convenient combinator functions.
pub trait TryStreamExt: TryStream {
    /// Flattens a stream of iterators into one continuous stream.
    fn try_flatten_iters(self) -> TryFlattenIters<Self>
    where
        Self::Ok: IntoIterator,
        <Self::Ok as IntoIterator>::IntoIter: Unpin,
        Self: Sized,
    {
        TryFlattenIters::new(self)
    }
}

/// Stream for the [`try_flatten`](super::TryStreamExt::try_flatten) method.
#[pin_project]
// #[derive(Debug)]
#[must_use = "streams do nothing unless polled"]
pub struct TryFlattenIters<St>
where
    St: TryStream,
    St::Ok: IntoIterator,
{
    #[pin]
    stream: St,
    #[pin]
    next: Option<<St::Ok as IntoIterator>::IntoIter>,
}

impl<St> TryFlattenIters<St>
where
    St: TryStream,
    St::Ok: IntoIterator,
    <St::Ok as IntoIterator>::IntoIter: Unpin,
{
    pub(crate) fn new(stream: St) -> Self {
        Self { stream, next: None }
    }

    /// Acquires a reference to the underlying sink or stream that this combinator is
    /// pulling from.
    pub fn get_ref(&self) -> &St {
        &self.stream
    }

    /// Acquires a mutable reference to the underlying sink or stream that this
    /// combinator is pulling from.
    ///
    /// Note that care must be taken to avoid tampering with the state of the
    /// sink or stream which may otherwise confuse this combinator.
    pub fn get_mut(&mut self) -> &mut St {
        &mut self.stream
    }

    /// Acquires a pinned mutable reference to the underlying sink or stream that this
    /// combinator is pulling from.
    ///
    /// Note that care must be taken to avoid tampering with the state of the
    /// sink or stream which may otherwise confuse this combinator.
    pub fn get_pin_mut(self: core::pin::Pin<&mut Self>) -> core::pin::Pin<&mut St> {
        self.project().stream
    }

    /// Consumes this combinator, returning the underlying sink or stream.
    ///
    /// Note that this may discard intermediate state of this combinator, so
    /// care should be taken to avoid losing resources when this is called.
    pub fn into_inner(self) -> St {
        self.stream
    }
}

impl<St> FusedStream for TryFlattenIters<St>
where
    St: TryStream + FusedStream,
    St::Ok: IntoIterator,
    <St::Ok as IntoIterator>::IntoIter: Unpin,
{
    fn is_terminated(&self) -> bool {
        self.next.is_none() && self.stream.is_terminated()
    }
}

impl<St> Stream for TryFlattenIters<St>
where
    St: TryStream,
    St::Ok: IntoIterator,
    <St::Ok as IntoIterator>::IntoIter: Unpin,
{
    type Item = Result<<St::Ok as IntoIterator>::Item, St::Error>;

    #[project]
    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        #[project]
        let TryFlattenIters {
            mut stream,
            mut next,
        } = self.project();
        Poll::Ready(loop {
            if let Some(mut s) = next.as_mut().as_pin_mut() {
                if let Some(item) = s.next() {
                    break Some(Ok(item));
                } else {
                    next.set(None);
                }
            } else if let Some(s) = ready!(stream.as_mut().try_poll_next(cx)?) {
                next.set(Some(s.into_iter()));
            } else {
                break None;
            }
        })
    }
}

#[cfg(test)]
mod tests {
    use super::TryStreamExt as _;
    use futures::stream::{iter, StreamExt, TryStreamExt};

    #[derive(Debug, Copy, Clone, Eq, PartialEq)]
    struct CustomError;

    #[tokio::test]
    async fn test_basic() {
        let input: Vec<Result<Vec<usize>, CustomError>> = vec![
            Ok(vec![0_usize, 1, 2]),
            Ok(vec![3, 4]),
            Ok(vec![]),
            Ok(vec![5, 6, 7]),
        ];
        let mut stream = iter(input).try_flatten_iters();

        assert_eq!(stream.next().await, Some(Ok(0)));
        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, Some(Ok(4)));
        assert_eq!(stream.next().await, Some(Ok(5)));
        assert_eq!(stream.next().await, Some(Ok(6)));
        assert_eq!(stream.next().await, Some(Ok(7)));
        assert_eq!(stream.next().await, None);
    }

    #[tokio::test]
    async fn test_error() {
        let input: Vec<Result<Vec<usize>, CustomError>> = vec![
            Ok(vec![0_usize, 1, 2]),
            Err(CustomError),
            Ok(vec![]),
            Ok(vec![5, 6, 7]),
        ];
        let mut stream = iter(input).try_flatten_iters();

        assert_eq!(stream.next().await, Some(Ok(0)));
        assert_eq!(stream.next().await, Some(Ok(1)));
        assert_eq!(stream.next().await, Some(Ok(2)));
        assert_eq!(stream.next().await, Some(Err(CustomError)));
        assert_eq!(stream.next().await, Some(Ok(5)));
        assert_eq!(stream.next().await, Some(Ok(6)));
        assert_eq!(stream.next().await, Some(Ok(7)));
        assert_eq!(stream.next().await, None);
    }

    #[tokio::test]
    async fn test_error_with_collect() {
        let input: Vec<Result<Vec<usize>, CustomError>> = vec![
            Ok(vec![0_usize, 1, 2]),
            Ok(vec![3, 4]),
            Ok(vec![]),
            Ok(vec![5, 6, 7]),
        ];
        let result: Result<Vec<usize>, CustomError> =
            iter(input).try_flatten_iters().try_collect().await;
        assert_eq!(result, Ok(vec![0, 1, 2, 3, 4, 5, 6, 7]));

        let input: Vec<Result<Vec<usize>, CustomError>> = vec![
            Ok(vec![0_usize, 1, 2]),
            Err(CustomError),
            Ok(vec![]),
            Ok(vec![5, 6, 7]),
        ];
        let result: Result<Vec<usize>, CustomError> =
            iter(input).try_flatten_iters().try_collect().await;
        assert_eq!(result, Err(CustomError));
    }

    #[tokio::test]
    async fn test_empty() {
        let mut stream = iter(Vec::<Result<Vec<String>, CustomError>>::new()).try_flatten_iters();

        assert_eq!(stream.next().await, None);
    }
}