futures_rx/stream_ext/
materialize.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
use std::{
    pin::Pin,
    task::{Context, Poll},
};

use futures::{stream::FusedStream, Stream};
use pin_project_lite::pin_project;

use crate::Notification;

pin_project! {
    /// Stream for the [`start_with`](RxStreamExt::start_with) method.
    #[must_use = "streams do nothing unless polled"]
    pub struct Materialize<S: Stream> {
        #[pin]
        stream: S,
        did_complete: bool,
    }
}

impl<S: Stream> Materialize<S> {
    pub(crate) fn new(stream: S) -> Self {
        Self {
            stream,
            did_complete: false,
        }
    }
}

impl<S: FusedStream> FusedStream for Materialize<S> {
    fn is_terminated(&self) -> bool {
        self.stream.is_terminated()
    }
}

impl<S: Stream> Stream for Materialize<S> {
    type Item = Notification<S::Item>;

    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let mut this = self.project();

        match this.stream.as_mut().poll_next(cx) {
            Poll::Ready(Some(event)) => Poll::Ready(Some(Notification::Next(event))),
            Poll::Ready(None) => {
                if *this.did_complete {
                    Poll::Ready(None)
                } else {
                    *this.did_complete = true;
                    Poll::Ready(Some(Notification::Complete))
                }
            }
            Poll::Pending => Poll::Pending,
        }
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        let (a, b) = self.stream.size_hint();

        (a + 1, b.map(|it| it + 1))
    }
}

#[cfg(test)]
mod test {
    use futures::{executor::block_on, stream, StreamExt};

    use crate::{Notification, RxExt};

    #[test]
    fn smoke() {
        block_on(async {
            let stream = stream::iter(1..=2);
            let all_events = stream.materialize().collect::<Vec<_>>().await;

            assert_eq!(
                all_events,
                [
                    Notification::Next(1),
                    Notification::Next(2),
                    Notification::Complete
                ]
            );
        });
    }
}