| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tokio-util-0.7.8/src/io/sink_writer.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>sink_writer.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../tokio_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tokio_util/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>futures_core::ready; |
| <span class="kw">use </span>futures_sink::Sink; |
| |
| <span class="kw">use </span>pin_project_lite::pin_project; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::pin::Pin; |
| <span class="kw">use </span>std::task::{Context, Poll}; |
| <span class="kw">use </span>tokio::io::AsyncWrite; |
| |
| <span class="macro">pin_project! </span>{ |
| <span class="doccomment">/// Convert a [`Sink`] of byte chunks into an [`AsyncWrite`]. |
| /// |
| /// Whenever you write to this [`SinkWriter`], the supplied bytes are |
| /// forwarded to the inner [`Sink`]. When `shutdown` is called on this |
| /// [`SinkWriter`], the inner sink is closed. |
| /// |
| /// This adapter takes a `Sink<&[u8]>` and provides an [`AsyncWrite`] impl |
| /// for it. Because of the lifetime, this trait is relatively rarely |
| /// implemented. The main ways to get a `Sink<&[u8]>` that you can use with |
| /// this type are: |
| /// |
| /// * With the codec module by implementing the [`Encoder`]`<&[u8]>` trait. |
| /// * By wrapping a `Sink<Bytes>` in a [`CopyToBytes`]. |
| /// * Manually implementing `Sink<&[u8]>` directly. |
| /// |
| /// The opposite conversion of implementing `Sink<_>` for an [`AsyncWrite`] |
| /// is done using the [`codec`] module. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use bytes::Bytes; |
| /// use futures_util::SinkExt; |
| /// use std::io::{Error, ErrorKind}; |
| /// use tokio::io::AsyncWriteExt; |
| /// use tokio_util::io::{SinkWriter, CopyToBytes}; |
| /// use tokio_util::sync::PollSender; |
| /// |
| /// # #[tokio::main(flavor = "current_thread")] |
| /// # async fn main() -> Result<(), Error> { |
| /// // We use an mpsc channel as an example of a `Sink<Bytes>`. |
| /// let (tx, mut rx) = tokio::sync::mpsc::channel::<Bytes>(1); |
| /// let sink = PollSender::new(tx).sink_map_err(|_| Error::from(ErrorKind::BrokenPipe)); |
| /// |
| /// // Wrap it in `CopyToBytes` to get a `Sink<&[u8]>`. |
| /// let mut writer = SinkWriter::new(CopyToBytes::new(sink)); |
| /// |
| /// // Write data to our interface... |
| /// let data: [u8; 4] = [1, 2, 3, 4]; |
| /// let _ = writer.write(&data).await?; |
| /// |
| /// // ... and receive it. |
| /// assert_eq!(data.as_slice(), &*rx.recv().await.unwrap()); |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| /// |
| /// [`AsyncWrite`]: tokio::io::AsyncWrite |
| /// [`CopyToBytes`]: crate::io::CopyToBytes |
| /// [`Encoder`]: crate::codec::Encoder |
| /// [`Sink`]: futures_sink::Sink |
| /// [`codec`]: tokio_util::codec |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>SinkWriter<S> { |
| <span class="attribute">#[pin] |
| </span>inner: S, |
| } |
| } |
| |
| <span class="kw">impl</span><S> SinkWriter<S> { |
| <span class="doccomment">/// Creates a new [`SinkWriter`]. |
| </span><span class="kw">pub fn </span>new(sink: S) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ inner: sink } |
| } |
| |
| <span class="doccomment">/// Gets a reference to the underlying sink. |
| </span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>S { |
| <span class="kw-2">&</span><span class="self">self</span>.inner |
| } |
| |
| <span class="doccomment">/// Gets a mutable reference to the underlying sink. |
| </span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>S { |
| <span class="kw-2">&mut </span><span class="self">self</span>.inner |
| } |
| |
| <span class="doccomment">/// Consumes this [`SinkWriter`], returning the underlying sink. |
| </span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -> S { |
| <span class="self">self</span>.inner |
| } |
| } |
| <span class="kw">impl</span><S, E> AsyncWrite <span class="kw">for </span>SinkWriter<S> |
| <span class="kw">where |
| for</span><<span class="lifetime">'a</span>> S: Sink<<span class="kw-2">&</span><span class="lifetime">'a </span>[u8], Error = E>, |
| E: Into<io::Error>, |
| { |
| <span class="kw">fn </span>poll_write( |
| <span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&</span>[u8], |
| ) -> Poll<<span class="prelude-ty">Result</span><usize, io::Error>> { |
| <span class="kw">let </span><span class="kw-2">mut </span>this = <span class="self">self</span>.project(); |
| |
| <span class="macro">ready!</span>(this.inner.as_mut().poll_ready(cx).map_err(Into::into))<span class="question-mark">?</span>; |
| <span class="kw">match </span>this.inner.as_mut().start_send(buf) { |
| <span class="prelude-val">Ok</span>(()) => Poll::Ready(<span class="prelude-val">Ok</span>(buf.len())), |
| <span class="prelude-val">Err</span>(e) => Poll::Ready(<span class="prelude-val">Err</span>(e.into())), |
| } |
| } |
| |
| <span class="kw">fn </span>poll_flush(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><(), io::Error>> { |
| <span class="self">self</span>.project().inner.poll_flush(cx).map_err(Into::into) |
| } |
| |
| <span class="kw">fn </span>poll_shutdown(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><(), io::Error>> { |
| <span class="self">self</span>.project().inner.poll_close(cx).map_err(Into::into) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tokio_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
