blob: 248ca756afd66e6ec2e8bf814243a0fb19d7ed76 [file] [log] [blame]
<!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/futures-util-0.3.28/src/io/into_sink.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>into_sink.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="../../../futures_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="../../../futures_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>
</pre><pre class="rust"><code><span class="kw">use </span>futures_core::ready;
<span class="kw">use </span>futures_core::task::{Context, Poll};
<span class="kw">use </span>futures_io::AsyncWrite;
<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="attribute">#[derive(Debug)]
</span><span class="kw">struct </span>Block&lt;Item&gt; {
offset: usize,
bytes: Item,
}
<span class="macro">pin_project! </span>{
<span class="doccomment">/// Sink for the [`into_sink`](super::AsyncWriteExt::into_sink) method.
</span><span class="attribute">#[must_use = <span class="string">&quot;sinks do nothing unless polled&quot;</span>]
#[derive(Debug)]
#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">&quot;sink&quot;</span>)))]
</span><span class="kw">pub struct </span>IntoSink&lt;W, Item&gt; {
<span class="attribute">#[pin]
</span>writer: W,
<span class="comment">// An outstanding block for us to push into the underlying writer, along with an offset of how
// far into this block we have written already.
</span>buffer: <span class="prelude-ty">Option</span>&lt;Block&lt;Item&gt;&gt;,
}
}
<span class="kw">impl</span>&lt;W: AsyncWrite, Item: AsRef&lt;[u8]&gt;&gt; IntoSink&lt;W, Item&gt; {
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(writer: W) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{ writer, buffer: <span class="prelude-val">None </span>}
}
<span class="doccomment">/// If we have an outstanding block in `buffer` attempt to push it into the writer, does _not_
/// flush the writer after it succeeds in pushing the block into it.
</span><span class="kw">fn </span>poll_flush_buffer(
<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;,
cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
) -&gt; Poll&lt;<span class="prelude-ty">Result</span>&lt;(), io::Error&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>this = <span class="self">self</span>.project();
<span class="kw">if let </span><span class="prelude-val">Some</span>(buffer) = this.buffer {
<span class="kw">loop </span>{
<span class="kw">let </span>bytes = buffer.bytes.as_ref();
<span class="kw">let </span>written = <span class="macro">ready!</span>(this.writer.as_mut().poll_write(cx, <span class="kw-2">&amp;</span>bytes[buffer.offset..]))<span class="question-mark">?</span>;
buffer.offset += written;
<span class="kw">if </span>buffer.offset == bytes.len() {
<span class="kw">break</span>;
}
}
}
<span class="kw-2">*</span>this.buffer = <span class="prelude-val">None</span>;
Poll::Ready(<span class="prelude-val">Ok</span>(()))
}
}
<span class="kw">impl</span>&lt;W: AsyncWrite, Item: AsRef&lt;[u8]&gt;&gt; Sink&lt;Item&gt; <span class="kw">for </span>IntoSink&lt;W, Item&gt; {
<span class="kw">type </span>Error = io::Error;
<span class="kw">fn </span>poll_ready(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;<span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Error&gt;&gt; {
<span class="macro">ready!</span>(<span class="self">self</span>.poll_flush_buffer(cx))<span class="question-mark">?</span>;
Poll::Ready(<span class="prelude-val">Ok</span>(()))
}
<span class="kw">fn </span>start_send(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, item: Item) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Error&gt; {
<span class="macro">debug_assert!</span>(<span class="self">self</span>.buffer.is_none());
<span class="kw-2">*</span><span class="self">self</span>.project().buffer = <span class="prelude-val">Some</span>(Block { offset: <span class="number">0</span>, bytes: item });
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>poll_flush(<span class="kw-2">mut </span><span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;<span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Error&gt;&gt; {
<span class="macro">ready!</span>(<span class="self">self</span>.as_mut().poll_flush_buffer(cx))<span class="question-mark">?</span>;
<span class="macro">ready!</span>(<span class="self">self</span>.project().writer.poll_flush(cx))<span class="question-mark">?</span>;
Poll::Ready(<span class="prelude-val">Ok</span>(()))
}
<span class="kw">fn </span>poll_close(<span class="kw-2">mut </span><span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;<span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Error&gt;&gt; {
<span class="macro">ready!</span>(<span class="self">self</span>.as_mut().poll_flush_buffer(cx))<span class="question-mark">?</span>;
<span class="macro">ready!</span>(<span class="self">self</span>.project().writer.poll_close(cx))<span class="question-mark">?</span>;
Poll::Ready(<span class="prelude-val">Ok</span>(()))
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>