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

use crate::io::util::poll_proceed_and_make_progress;
use crate::io::AsyncWrite;

use std::fmt;
use std::io;
use std::pin::Pin;
use std::task::{ready, Context, Poll};

cfg_io_util! {
    /// An async writer which will move data into the void.
    ///
    /// This struct is generally created by calling [`sink`][sink]. Please
    /// see the documentation of `sink()` for more details.
    ///
    /// This is an asynchronous version of [`std::io::Sink`][std].
    ///
    /// [sink]: sink()
    /// [std]: std::io::Sink
    pub struct Sink {
        _p: (),
    }

    /// Creates an instance of an async writer which will successfully consume all
    /// data.
    ///
    /// All calls to [`poll_write`] on the returned instance will return
    /// `Poll::Ready(Ok(buf.len()))` and the contents of the buffer will not be
    /// inspected.
    ///
    /// This is an asynchronous version of [`std::io::sink`][std].
    ///
    /// [`poll_write`]: crate::io::AsyncWrite::poll_write()
    /// [std]: std::io::sink
    ///
    /// # Examples
    ///
    /// ```
    /// use tokio::io::{self, AsyncWriteExt};
    ///
    /// #[tokio::main]
    /// async fn main() -> io::Result<()> {
    ///     let buffer = vec![1, 2, 3, 5, 8];
    ///     let num_bytes = io::sink().write(&buffer).await?;
    ///     assert_eq!(num_bytes, 5);
    ///     Ok(())
    /// }
    /// ```
    pub fn sink() -> Sink {
        Sink { _p: () }
    }
}

impl AsyncWrite for Sink {
    #[inline]
    fn poll_write(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<Result<usize, io::Error>> {
        ready!(crate::trace::trace_leaf(cx));
        ready!(poll_proceed_and_make_progress(cx));
        Poll::Ready(Ok(buf.len()))
    }

    #[inline]
    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
        ready!(crate::trace::trace_leaf(cx));
        ready!(poll_proceed_and_make_progress(cx));
        Poll::Ready(Ok(()))
    }

    #[inline]
    fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
        ready!(crate::trace::trace_leaf(cx));
        ready!(poll_proceed_and_make_progress(cx));
        Poll::Ready(Ok(()))
    }
}

impl fmt::Debug for Sink {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.pad("Sink { .. }")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn assert_unpin() {
        crate::is_unpin::<Sink>();
    }
}