blob: 2a77c7708146ea102c4fd428b1e44a1c117cd613 [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/hyper-0.14.26/src/common/buf.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>buf.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="../../../hyper/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="../../../hyper/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>
</pre><pre class="rust"><code><span class="kw">use </span>std::collections::VecDeque;
<span class="kw">use </span>std::io::IoSlice;
<span class="kw">use </span>bytes::{Buf, BufMut, Bytes, BytesMut};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>BufList&lt;T&gt; {
bufs: VecDeque&lt;T&gt;,
}
<span class="kw">impl</span>&lt;T: Buf&gt; BufList&lt;T&gt; {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new() -&gt; BufList&lt;T&gt; {
BufList {
bufs: VecDeque::new(),
}
}
<span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>push(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: T) {
<span class="macro">debug_assert!</span>(buf.has_remaining());
<span class="self">self</span>.bufs.push_back(buf);
}
<span class="attribute">#[inline]
#[cfg(feature = <span class="string">&quot;http1&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>bufs_cnt(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.bufs.len()
}
}
<span class="kw">impl</span>&lt;T: Buf&gt; Buf <span class="kw">for </span>BufList&lt;T&gt; {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>remaining(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.bufs.iter().map(|buf| buf.remaining()).sum()
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>chunk(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[u8] {
<span class="self">self</span>.bufs.front().map(Buf::chunk).unwrap_or_default()
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>advance(<span class="kw-2">&amp;mut </span><span class="self">self</span>, <span class="kw-2">mut </span>cnt: usize) {
<span class="kw">while </span>cnt &gt; <span class="number">0 </span>{
{
<span class="kw">let </span>front = <span class="kw-2">&amp;mut </span><span class="self">self</span>.bufs[<span class="number">0</span>];
<span class="kw">let </span>rem = front.remaining();
<span class="kw">if </span>rem &gt; cnt {
front.advance(cnt);
<span class="kw">return</span>;
} <span class="kw">else </span>{
front.advance(rem);
cnt -= rem;
}
}
<span class="self">self</span>.bufs.pop_front();
}
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>chunks_vectored&lt;<span class="lifetime">&#39;t</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;t </span><span class="self">self</span>, dst: <span class="kw-2">&amp;mut </span>[IoSlice&lt;<span class="lifetime">&#39;t</span>&gt;]) -&gt; usize {
<span class="kw">if </span>dst.is_empty() {
<span class="kw">return </span><span class="number">0</span>;
}
<span class="kw">let </span><span class="kw-2">mut </span>vecs = <span class="number">0</span>;
<span class="kw">for </span>buf <span class="kw">in </span><span class="kw-2">&amp;</span><span class="self">self</span>.bufs {
vecs += buf.chunks_vectored(<span class="kw-2">&amp;mut </span>dst[vecs..]);
<span class="kw">if </span>vecs == dst.len() {
<span class="kw">break</span>;
}
}
vecs
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>copy_to_bytes(<span class="kw-2">&amp;mut </span><span class="self">self</span>, len: usize) -&gt; Bytes {
<span class="comment">// Our inner buffer may have an optimized version of copy_to_bytes, and if the whole
// request can be fulfilled by the front buffer, we can take advantage.
</span><span class="kw">match </span><span class="self">self</span>.bufs.front_mut() {
<span class="prelude-val">Some</span>(front) <span class="kw">if </span>front.remaining() == len =&gt; {
<span class="kw">let </span>b = front.copy_to_bytes(len);
<span class="self">self</span>.bufs.pop_front();
b
}
<span class="prelude-val">Some</span>(front) <span class="kw">if </span>front.remaining() &gt; len =&gt; front.copy_to_bytes(len),
<span class="kw">_ </span>=&gt; {
<span class="macro">assert!</span>(len &lt;= <span class="self">self</span>.remaining(), <span class="string">&quot;`len` greater than remaining&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>bm = BytesMut::with_capacity(len);
bm.put(<span class="self">self</span>.take(len));
bm.freeze()
}
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>std::ptr;
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">fn </span>hello_world_buf() -&gt; BufList&lt;Bytes&gt; {
BufList {
bufs: <span class="macro">vec!</span>[Bytes::from(<span class="string">&quot;Hello&quot;</span>), Bytes::from(<span class="string">&quot; &quot;</span>), Bytes::from(<span class="string">&quot;World&quot;</span>)].into(),
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>to_bytes_shorter() {
<span class="kw">let </span><span class="kw-2">mut </span>bufs = hello_world_buf();
<span class="kw">let </span>old_ptr = bufs.chunk().as_ptr();
<span class="kw">let </span>start = bufs.copy_to_bytes(<span class="number">4</span>);
<span class="macro">assert_eq!</span>(start, <span class="string">&quot;Hell&quot;</span>);
<span class="macro">assert!</span>(ptr::eq(old_ptr, start.as_ptr()));
<span class="macro">assert_eq!</span>(bufs.chunk(), <span class="string">b&quot;o&quot;</span>);
<span class="macro">assert!</span>(ptr::eq(old_ptr.wrapping_add(<span class="number">4</span>), bufs.chunk().as_ptr()));
<span class="macro">assert_eq!</span>(bufs.remaining(), <span class="number">7</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>to_bytes_eq() {
<span class="kw">let </span><span class="kw-2">mut </span>bufs = hello_world_buf();
<span class="kw">let </span>old_ptr = bufs.chunk().as_ptr();
<span class="kw">let </span>start = bufs.copy_to_bytes(<span class="number">5</span>);
<span class="macro">assert_eq!</span>(start, <span class="string">&quot;Hello&quot;</span>);
<span class="macro">assert!</span>(ptr::eq(old_ptr, start.as_ptr()));
<span class="macro">assert_eq!</span>(bufs.chunk(), <span class="string">b&quot; &quot;</span>);
<span class="macro">assert_eq!</span>(bufs.remaining(), <span class="number">6</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>to_bytes_longer() {
<span class="kw">let </span><span class="kw-2">mut </span>bufs = hello_world_buf();
<span class="kw">let </span>start = bufs.copy_to_bytes(<span class="number">7</span>);
<span class="macro">assert_eq!</span>(start, <span class="string">&quot;Hello W&quot;</span>);
<span class="macro">assert_eq!</span>(bufs.remaining(), <span class="number">4</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>one_long_buf_to_bytes() {
<span class="kw">let </span><span class="kw-2">mut </span>buf = BufList::new();
buf.push(<span class="string">b&quot;Hello World&quot; </span><span class="kw">as </span><span class="kw-2">&amp;</span>[<span class="kw">_</span>]);
<span class="macro">assert_eq!</span>(buf.copy_to_bytes(<span class="number">5</span>), <span class="string">&quot;Hello&quot;</span>);
<span class="macro">assert_eq!</span>(buf.chunk(), <span class="string">b&quot; World&quot;</span>);
}
<span class="attribute">#[test]
#[should_panic(expected = <span class="string">&quot;`len` greater than remaining&quot;</span>)]
</span><span class="kw">fn </span>buf_to_bytes_too_many() {
hello_world_buf().copy_to_bytes(<span class="number">42</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="hyper" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>