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 core::pin::Pin;
use futures_core::future::Future;
use futures_core::task::{Waker, Poll};
use futures_sink::Sink;

/// Future for the `flush` combinator, which polls the sink until all data
/// has been flushed.
#[derive(Debug)]
#[must_use = "futures do nothing unless polled"]
pub struct Flush<'a, Si: Unpin + ?Sized> {
    sink: &'a mut Si,
}

// Pin is never projected to a field.
impl<Si: Unpin + ?Sized> Unpin for Flush<'_, Si> {}

/// A future that completes when the sink has finished processing all
/// pending requests.
///
/// The sink itself is returned after flushing is complete; this adapter is
/// intended to be used when you want to stop sending to the sink until
/// all current requests are processed.
impl<'a, Si: Sink + Unpin + ?Sized> Flush<'a, Si> {
    pub(super) fn new(sink: &'a mut Si) -> Self {
        Flush { sink }
    }
}

impl<Si: Sink + Unpin + ?Sized> Future for Flush<'_, Si> {
    type Output = Result<(), Si::SinkError>;

    fn poll(
        mut self: Pin<&mut Self>,
        waker: &Waker,
    ) -> Poll<Self::Output> {
        Pin::new(&mut self.sink).poll_flush(waker)
    }
}