blob: bb85703a8de6d9e62015a00f6798219e86f3ae01 [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/buf_writer.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>buf_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="../../../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>
<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>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::DEFAULT_BUF_SIZE;
<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::{AsyncBufRead, AsyncRead, AsyncSeek, AsyncWrite, IoSlice, SeekFrom};
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::io::{<span class="self">self</span>, Write};
<span class="kw">use </span>std::pin::Pin;
<span class="kw">use </span>std::ptr;
<span class="macro">pin_project! </span>{
<span class="doccomment">/// Wraps a writer and buffers its output.
///
/// It can be excessively inefficient to work directly with something that
/// implements [`AsyncWrite`]. A `BufWriter` keeps an in-memory buffer of data and
/// writes it to an underlying writer in large, infrequent batches.
///
/// `BufWriter` can improve the speed of programs that make *small* and
/// *repeated* write calls to the same file or network socket. It does not
/// help when writing very large amounts at once, or writing just one or a few
/// times. It also provides no advantage when writing to a destination that is
/// in memory, like a `Vec&lt;u8&gt;`.
///
/// When the `BufWriter` is dropped, the contents of its buffer will be
/// discarded. Creating multiple instances of a `BufWriter` on the same
/// stream can cause data loss. If you need to write out the contents of its
/// buffer, you must manually call flush before the writer is dropped.
///
/// [`AsyncWrite`]: futures_io::AsyncWrite
/// [`flush`]: super::AsyncWriteExt::flush
///
</span><span class="comment">// TODO: Examples
</span><span class="kw">pub struct </span>BufWriter&lt;W&gt; {
<span class="attribute">#[pin]
</span>inner: W,
buf: Vec&lt;u8&gt;,
written: usize,
}
}
<span class="kw">impl</span>&lt;W: AsyncWrite&gt; BufWriter&lt;W&gt; {
<span class="doccomment">/// Creates a new `BufWriter` with a default buffer capacity. The default is currently 8 KB,
/// but may change in the future.
</span><span class="kw">pub fn </span>new(inner: W) -&gt; <span class="self">Self </span>{
<span class="self">Self</span>::with_capacity(DEFAULT_BUF_SIZE, inner)
}
<span class="doccomment">/// Creates a new `BufWriter` with the specified buffer capacity.
</span><span class="kw">pub fn </span>with_capacity(cap: usize, inner: W) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{ inner, buf: Vec::with_capacity(cap), written: <span class="number">0 </span>}
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>flush_buf(<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;io::Result&lt;()&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>this = <span class="self">self</span>.project();
<span class="kw">let </span>len = this.buf.len();
<span class="kw">let </span><span class="kw-2">mut </span>ret = <span class="prelude-val">Ok</span>(());
<span class="kw">while </span><span class="kw-2">*</span>this.written &lt; len {
<span class="kw">match </span><span class="macro">ready!</span>(this.inner.as_mut().poll_write(cx, <span class="kw-2">&amp;</span>this.buf[<span class="kw-2">*</span>this.written..])) {
<span class="prelude-val">Ok</span>(<span class="number">0</span>) =&gt; {
ret = <span class="prelude-val">Err</span>(io::Error::new(
io::ErrorKind::WriteZero,
<span class="string">&quot;failed to write the buffered data&quot;</span>,
));
<span class="kw">break</span>;
}
<span class="prelude-val">Ok</span>(n) =&gt; <span class="kw-2">*</span>this.written += n,
<span class="prelude-val">Err</span>(e) =&gt; {
ret = <span class="prelude-val">Err</span>(e);
<span class="kw">break</span>;
}
}
}
<span class="kw">if </span><span class="kw-2">*</span>this.written &gt; <span class="number">0 </span>{
this.buf.drain(..<span class="kw-2">*</span>this.written);
}
<span class="kw-2">*</span>this.written = <span class="number">0</span>;
Poll::Ready(ret)
}
<span class="macro">delegate_access_inner!</span>(inner, W, ());
<span class="doccomment">/// Returns a reference to the internally buffered data.
</span><span class="kw">pub fn </span>buffer(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[u8] {
<span class="kw-2">&amp;</span><span class="self">self</span>.buf
}
<span class="doccomment">/// Capacity of `buf`. how many chars can be held in buffer
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>capacity(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.buf.capacity()
}
<span class="doccomment">/// Remaining number of bytes to reach `buf` &#39;s capacity
</span><span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>spare_capacity(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.buf.capacity() - <span class="self">self</span>.buf.len()
}
<span class="doccomment">/// Write a byte slice directly into buffer
///
/// Will truncate the number of bytes written to `spare_capacity()` so you want to
/// calculate the size of your slice to avoid losing bytes
///
/// Based on `std::io::BufWriter`
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>write_to_buf(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; usize {
<span class="kw">let </span>available = <span class="self">self</span>.spare_capacity();
<span class="kw">let </span>amt_to_buffer = available.min(buf.len());
<span class="comment">// SAFETY: `amt_to_buffer` is &lt;= buffer&#39;s spare capacity by construction.
</span><span class="kw">unsafe </span>{
<span class="self">self</span>.write_to_buffer_unchecked(<span class="kw-2">&amp;</span>buf[..amt_to_buffer]);
}
amt_to_buffer
}
<span class="doccomment">/// Write byte slice directly into `self.buf`
///
/// Based on `std::io::BufWriter`
</span><span class="attribute">#[inline]
</span><span class="kw">unsafe fn </span>write_to_buffer_unchecked(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, buf: <span class="kw-2">&amp;</span>[u8]) {
<span class="macro">debug_assert!</span>(buf.len() &lt;= <span class="self">self</span>.spare_capacity());
<span class="kw">let </span>this = <span class="self">self</span>.project();
<span class="kw">let </span>old_len = this.buf.len();
<span class="kw">let </span>buf_len = buf.len();
<span class="kw">let </span>src = buf.as_ptr();
<span class="kw">let </span>dst = this.buf.as_mut_ptr().add(old_len);
ptr::copy_nonoverlapping(src, dst, buf_len);
this.buf.set_len(old_len + buf_len);
}
<span class="doccomment">/// Write directly using `inner`, bypassing buffering
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>inner_poll_write(
<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;,
buf: <span class="kw-2">&amp;</span>[u8],
) -&gt; Poll&lt;io::Result&lt;usize&gt;&gt; {
<span class="self">self</span>.project().inner.poll_write(cx, buf)
}
<span class="doccomment">/// Write directly using `inner`, bypassing buffering
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>inner_poll_write_vectored(
<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;,
bufs: <span class="kw-2">&amp;</span>[IoSlice&lt;<span class="lifetime">&#39;_</span>&gt;],
) -&gt; Poll&lt;io::Result&lt;usize&gt;&gt; {
<span class="self">self</span>.project().inner.poll_write_vectored(cx, bufs)
}
}
<span class="kw">impl</span>&lt;W: AsyncWrite&gt; AsyncWrite <span class="kw">for </span>BufWriter&lt;W&gt; {
<span class="kw">fn </span>poll_write(
<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;,
buf: <span class="kw-2">&amp;</span>[u8],
) -&gt; Poll&lt;io::Result&lt;usize&gt;&gt; {
<span class="kw">if </span><span class="self">self</span>.buf.len() + buf.len() &gt; <span class="self">self</span>.buf.capacity() {
<span class="macro">ready!</span>(<span class="self">self</span>.as_mut().flush_buf(cx))<span class="question-mark">?</span>;
}
<span class="kw">if </span>buf.len() &gt;= <span class="self">self</span>.buf.capacity() {
<span class="self">self</span>.project().inner.poll_write(cx, buf)
} <span class="kw">else </span>{
Poll::Ready(<span class="self">self</span>.project().buf.write(buf))
}
}
<span class="kw">fn </span>poll_write_vectored(
<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;,
bufs: <span class="kw-2">&amp;</span>[IoSlice&lt;<span class="lifetime">&#39;_</span>&gt;],
) -&gt; Poll&lt;io::Result&lt;usize&gt;&gt; {
<span class="kw">let </span>total_len = bufs.iter().map(|b| b.len()).sum::&lt;usize&gt;();
<span class="kw">if </span><span class="self">self</span>.buf.len() + total_len &gt; <span class="self">self</span>.buf.capacity() {
<span class="macro">ready!</span>(<span class="self">self</span>.as_mut().flush_buf(cx))<span class="question-mark">?</span>;
}
<span class="kw">if </span>total_len &gt;= <span class="self">self</span>.buf.capacity() {
<span class="self">self</span>.project().inner.poll_write_vectored(cx, bufs)
} <span class="kw">else </span>{
Poll::Ready(<span class="self">self</span>.project().buf.write_vectored(bufs))
}
}
<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;io::Result&lt;()&gt;&gt; {
<span class="macro">ready!</span>(<span class="self">self</span>.as_mut().flush_buf(cx))<span class="question-mark">?</span>;
<span class="self">self</span>.project().inner.poll_flush(cx)
}
<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;io::Result&lt;()&gt;&gt; {
<span class="macro">ready!</span>(<span class="self">self</span>.as_mut().flush_buf(cx))<span class="question-mark">?</span>;
<span class="self">self</span>.project().inner.poll_close(cx)
}
}
<span class="kw">impl</span>&lt;W: AsyncRead&gt; AsyncRead <span class="kw">for </span>BufWriter&lt;W&gt; {
<span class="macro">delegate_async_read!</span>(inner);
}
<span class="kw">impl</span>&lt;W: AsyncBufRead&gt; AsyncBufRead <span class="kw">for </span>BufWriter&lt;W&gt; {
<span class="macro">delegate_async_buf_read!</span>(inner);
}
<span class="kw">impl</span>&lt;W: fmt::Debug&gt; fmt::Debug <span class="kw">for </span>BufWriter&lt;W&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
f.debug_struct(<span class="string">&quot;BufWriter&quot;</span>)
.field(<span class="string">&quot;writer&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.inner)
.field(<span class="string">&quot;buffer&quot;</span>, <span class="kw-2">&amp;</span><span class="macro">format_args!</span>(<span class="string">&quot;{}/{}&quot;</span>, <span class="self">self</span>.buf.len(), <span class="self">self</span>.buf.capacity()))
.field(<span class="string">&quot;written&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.written)
.finish()
}
}
<span class="kw">impl</span>&lt;W: AsyncWrite + AsyncSeek&gt; AsyncSeek <span class="kw">for </span>BufWriter&lt;W&gt; {
<span class="doccomment">/// Seek to the offset, in bytes, in the underlying writer.
///
/// Seeking always writes out the internal buffer before seeking.
</span><span class="kw">fn </span>poll_seek(
<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;,
pos: SeekFrom,
) -&gt; Poll&lt;io::Result&lt;u64&gt;&gt; {
<span class="macro">ready!</span>(<span class="self">self</span>.as_mut().flush_buf(cx))<span class="question-mark">?</span>;
<span class="self">self</span>.project().inner.poll_seek(cx, pos)
}
}
</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>