futures_util/future/
flatten_stream.rs

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
use core::fmt;

use futures_core::{Async, Future, Poll, Stream};
use futures_core::task;

/// Future for the `flatten_stream` combinator, flattening a
/// future-of-a-stream to get just the result of the final stream as a stream.
///
/// This is created by the `Future::flatten_stream` method.
#[must_use = "streams do nothing unless polled"]
pub struct FlattenStream<F>
    where F: Future,
          <F as Future>::Item: Stream<Error=F::Error>,
{
    state: State<F>
}

impl<F> fmt::Debug for FlattenStream<F>
    where F: Future + fmt::Debug,
          <F as Future>::Item: Stream<Error=F::Error> + fmt::Debug,
{
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        fmt.debug_struct("FlattenStream")
            .field("state", &self.state)
            .finish()
    }
}

pub fn new<F>(f: F) -> FlattenStream<F>
    where F: Future,
          <F as Future>::Item: Stream<Error=F::Error>,
{
    FlattenStream {
        state: State::Future(f)
    }
}

#[derive(Debug)]
enum State<F>
    where F: Future,
          <F as Future>::Item: Stream<Error=F::Error>,
{
    // future is not yet called or called and not ready
    Future(F),
    // future resolved to Stream
    Stream(F::Item),
    // EOF after future resolved to error
    Eof,
    // after EOF after future resolved to error
    Done,
}

impl<F> Stream for FlattenStream<F>
    where F: Future,
          <F as Future>::Item: Stream<Error=F::Error>,
{
    type Item = <F::Item as Stream>::Item;
    type Error = <F::Item as Stream>::Error;

    fn poll_next(&mut self, cx: &mut task::Context) -> Poll<Option<Self::Item>, Self::Error> {
        loop {
            let (next_state, ret_opt) = match self.state {
                State::Future(ref mut f) => {
                    match f.poll(cx) {
                        Ok(Async::Pending) => {
                            // State is not changed, early return.
                            return Ok(Async::Pending)
                        },
                        Ok(Async::Ready(stream)) => {
                            // Future resolved to stream.
                            // We do not return, but poll that
                            // stream in the next loop iteration.
                            (State::Stream(stream), None)
                        }
                        Err(e) => {
                            (State::Eof, Some(Err(e)))
                        }
                    }
                }
                State::Stream(ref mut s) => {
                    // Just forward call to the stream,
                    // do not track its state.
                    return s.poll_next(cx);
                }
                State::Eof => {
                    (State::Done, Some(Ok(Async::Ready(None))))
                }
                State::Done => {
                    panic!("poll called after eof");
                }
            };

            self.state = next_state;
            if let Some(ret) = ret_opt {
                return ret;
            }
        }
    }
}