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

use core::marker::{Unpin, PhantomData};
use core::pin::Pin;
use futures_core::stream::Stream;
use futures_core::task::{LocalWaker, Poll};
use futures_sink::Sink;
use pin_utils::{unsafe_pinned, unsafe_unpinned};

/// Sink for the `Sink::with_flat_map` combinator, chaining a computation that
/// returns an iterator to run prior to pushing a value into the underlying
/// sink.
#[derive(Debug)]
#[must_use = "sinks do nothing unless polled"]
pub struct WithFlatMap<Si, U, St, F>
where
    Si: Sink,
    F: FnMut(U) -> St,
    St: Stream<Item = Result<Si::SinkItem, Si::SinkError>>,
{
    sink: Si,
    f: F,
    stream: Option<St>,
    buffer: Option<Si::SinkItem>,
    _marker: PhantomData<fn(U)>,
}

impl<Si, U, St, F> Unpin for WithFlatMap<Si, U, St, F>
where
    Si: Sink + Unpin,
    F: FnMut(U) -> St,
    St: Stream<Item = Result<Si::SinkItem, Si::SinkError>> + Unpin,
{}

impl<Si, U, St, F> WithFlatMap<Si, U, St, F>
where
    Si: Sink,
    F: FnMut(U) -> St,
    St: Stream<Item = Result<Si::SinkItem, Si::SinkError>>,
{
    unsafe_pinned!(sink: Si);
    unsafe_unpinned!(f: F);
    unsafe_pinned!(stream: Option<St>);

    pub(super) fn new(sink: Si, f: F) -> WithFlatMap<Si, U, St, F> {
        WithFlatMap {
            sink,
            f,
            stream: None,
            buffer: None,
            _marker: PhantomData,
        }
    }

    /// Get a shared reference to the inner sink.
    pub fn get_ref(&self) -> &Si {
        &self.sink
    }

    /// Get a mutable reference to the inner sink.
    pub fn get_mut(&mut self) -> &mut Si {
        &mut self.sink
    }

    /// Get a pinned mutable reference to the inner sink.
    #[allow(clippy::needless_lifetimes)] // https://github.com/rust-lang/rust/issues/52675
    pub fn get_pin_mut<'a>(self: Pin<&'a mut Self>) -> Pin<&'a mut Si> {
        unsafe { Pin::map_unchecked_mut(self, |x| &mut x.sink) }
    }

    /// Consumes this combinator, returning the underlying sink.
    ///
    /// 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) -> Si {
        self.sink
    }

    fn try_empty_stream(
        self: Pin<&mut Self>,
        lw: &LocalWaker,
    ) -> Poll<Result<(), Si::SinkError>> {
        let WithFlatMap { sink, stream, buffer, .. } =
            unsafe { Pin::get_mut_unchecked(self) };
        let mut sink = unsafe { Pin::new_unchecked(sink) };
        let mut stream = unsafe { Pin::new_unchecked(stream) };

        if buffer.is_some() {
            try_ready!(sink.as_mut().poll_ready(lw));
            let item = buffer.take().unwrap();
            try_ready!(Poll::Ready(sink.as_mut().start_send(item)));
        }
        if let Some(mut some_stream) = stream.as_mut().as_pin_mut() {
            while let Some(x) = ready!(some_stream.as_mut().poll_next(lw)) {
                let item = try_ready!(Poll::Ready(x));
                match try_poll!(sink.as_mut().poll_ready(lw)) {
                    Poll::Ready(()) => {
                        try_poll!(Poll::Ready(sink.as_mut().start_send(item)))
                    }
                    Poll::Pending => {
                        *buffer = Some(item);
                        return Poll::Pending;
                    }
                };
            }
        }
        Pin::set(stream, None);
        Poll::Ready(Ok(()))
    }
}

impl<S, U, St, F> Stream for WithFlatMap<S, U, St, F>
where
    S: Stream + Sink,
    F: FnMut(U) -> St,
    St: Stream<Item = Result<S::SinkItem, S::SinkError>>,
{
    type Item = S::Item;
    fn poll_next(
        mut self: Pin<&mut Self>,
        lw: &LocalWaker,
    ) -> Poll<Option<S::Item>> {
        self.sink().poll_next(lw)
    }
}

impl<Si, U, St, F> Sink for WithFlatMap<Si, U, St, F>
where
    Si: Sink,
    F: FnMut(U) -> St,
    St: Stream<Item = Result<Si::SinkItem, Si::SinkError>>,
{
    type SinkItem = U;
    type SinkError = Si::SinkError;

    fn poll_ready(
        self: Pin<&mut Self>,
        lw: &LocalWaker,
    ) -> Poll<Result<(), Self::SinkError>> {
        self.try_empty_stream(lw)
    }

    fn start_send(
        mut self: Pin<&mut Self>,
        item: Self::SinkItem,
    ) -> Result<(), Self::SinkError> {
        assert!(self.stream().is_none());
        let stream = (self.f())(item);
        Pin::set(self.stream(), Some(stream));
        Ok(())
    }

    fn poll_flush(
        mut self: Pin<&mut Self>,
        lw: &LocalWaker,
    ) -> Poll<Result<(), Self::SinkError>> {
        match self.as_mut().try_empty_stream(lw) {
            Poll::Pending => Poll::Pending,
            Poll::Ready(Ok(())) => self.sink().poll_flush(lw),
            Poll::Ready(Err(e)) => Poll::Ready(Err(e)),
        }
    }

    fn poll_close(
        mut self: Pin<&mut Self>,
        lw: &LocalWaker,
    ) -> Poll<Result<(), Self::SinkError>> {
        match self.as_mut().try_empty_stream(lw) {
            Poll::Pending => Poll::Pending,
            Poll::Ready(Ok(())) => self.sink().poll_close(lw),
            Poll::Ready(Err(e)) => Poll::Ready(Err(e)),
        }
    }
}