blob: dba029f4cac55c40eda33f430c788152b662353e [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/git/checkouts/tantivy-65d0bbbddbbd5d02/433372d/ownedbytes/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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="../../ownedbytes/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="../../ownedbytes/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>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::convert::TryInto;
<span class="kw">use </span>std::ops::{Deref, Range};
<span class="kw">use </span>std::sync::Arc;
<span class="kw">use </span>std::{fmt, io, mem};
<span class="kw">use </span>stable_deref_trait::StableDeref;
<span class="doccomment">/// An OwnedBytes simply wraps an object that owns a slice of data and exposes
/// this data as a slice.
///
/// The backing object is required to be `StableDeref`.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>OwnedBytes {
data: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>[u8],
box_stable_deref: Arc&lt;<span class="kw">dyn </span>Deref&lt;Target = [u8]&gt; + Sync + Send&gt;,
}
<span class="kw">impl </span>OwnedBytes {
<span class="doccomment">/// Creates an empty `OwnedBytes`.
</span><span class="kw">pub fn </span>empty() -&gt; OwnedBytes {
OwnedBytes::new(<span class="kw-2">&amp;</span>[][..])
}
<span class="doccomment">/// Creates an `OwnedBytes` instance given a `StableDeref` object.
</span><span class="kw">pub fn </span>new&lt;T: StableDeref + Deref&lt;Target = [u8]&gt; + <span class="lifetime">&#39;static </span>+ Send + Sync&gt;(
data_holder: T,
) -&gt; OwnedBytes {
<span class="kw">let </span>box_stable_deref = Arc::new(data_holder);
<span class="kw">let </span>bytes: <span class="kw-2">&amp;</span>[u8] = box_stable_deref.as_ref();
<span class="kw">let </span>data = <span class="kw">unsafe </span>{ mem::transmute::&lt;<span class="kw">_</span>, <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>[u8]&gt;(bytes.deref()) };
OwnedBytes {
data,
box_stable_deref,
}
}
<span class="doccomment">/// creates a fileslice that is just a view over a slice of the data.
</span><span class="attribute">#[must_use]
#[inline]
</span><span class="kw">pub fn </span>slice(<span class="kw-2">&amp;</span><span class="self">self</span>, range: Range&lt;usize&gt;) -&gt; <span class="self">Self </span>{
OwnedBytes {
data: <span class="kw-2">&amp;</span><span class="self">self</span>.data[range],
box_stable_deref: <span class="self">self</span>.box_stable_deref.clone(),
}
}
<span class="doccomment">/// Returns the underlying slice of data.
/// `Deref` and `AsRef` are also available.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>as_slice(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[u8] {
<span class="self">self</span>.data
}
<span class="doccomment">/// Returns the len of the slice.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.data.len()
}
<span class="doccomment">/// Splits the OwnedBytes into two OwnedBytes `(left, right)`.
///
/// Left will hold `split_len` bytes.
///
/// This operation is cheap and does not require to copy any memory.
/// On the other hand, both `left` and `right` retain a handle over
/// the entire slice of memory. In other words, the memory will only
/// be released when both left and right are dropped.
</span><span class="attribute">#[inline]
#[must_use]
</span><span class="kw">pub fn </span>split(<span class="self">self</span>, split_len: usize) -&gt; (OwnedBytes, OwnedBytes) {
<span class="kw">let </span>right_box_stable_deref = <span class="self">self</span>.box_stable_deref.clone();
<span class="kw">let </span>left = OwnedBytes {
data: <span class="kw-2">&amp;</span><span class="self">self</span>.data[..split_len],
box_stable_deref: <span class="self">self</span>.box_stable_deref,
};
<span class="kw">let </span>right = OwnedBytes {
data: <span class="kw-2">&amp;</span><span class="self">self</span>.data[split_len..],
box_stable_deref: right_box_stable_deref,
};
(left, right)
}
<span class="doccomment">/// Splits the OwnedBytes into two OwnedBytes `(left, right)`.
///
/// Right will hold `split_len` bytes.
///
/// This operation is cheap and does not require to copy any memory.
/// On the other hand, both `left` and `right` retain a handle over
/// the entire slice of memory. In other words, the memory will only
/// be released when both left and right are dropped.
</span><span class="attribute">#[inline]
#[must_use]
</span><span class="kw">pub fn </span>rsplit(<span class="self">self</span>, split_len: usize) -&gt; (OwnedBytes, OwnedBytes) {
<span class="kw">let </span>data_len = <span class="self">self</span>.data.len();
<span class="self">self</span>.split(data_len - split_len)
}
<span class="doccomment">/// Splits the right part of the `OwnedBytes` at the given offset.
///
/// `self` is truncated to `split_len`, left with the remaining bytes.
</span><span class="kw">pub fn </span>split_off(<span class="kw-2">&amp;mut </span><span class="self">self</span>, split_len: usize) -&gt; OwnedBytes {
<span class="kw">let </span>right_box_stable_deref = <span class="self">self</span>.box_stable_deref.clone();
<span class="kw">let </span>right_piece = OwnedBytes {
data: <span class="kw-2">&amp;</span><span class="self">self</span>.data[split_len..],
box_stable_deref: right_box_stable_deref,
};
<span class="self">self</span>.data = <span class="kw-2">&amp;</span><span class="self">self</span>.data[..split_len];
right_piece
}
<span class="doccomment">/// Returns true iff this `OwnedBytes` is empty.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.as_slice().is_empty()
}
<span class="doccomment">/// Drops the left most `advance_len` bytes.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>advance(<span class="kw-2">&amp;mut </span><span class="self">self</span>, advance_len: usize) {
<span class="self">self</span>.data = <span class="kw-2">&amp;</span><span class="self">self</span>.data[advance_len..]
}
<span class="doccomment">/// Reads an `u8` from the `OwnedBytes` and advance by one byte.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>read_u8(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; u8 {
<span class="macro">assert!</span>(!<span class="self">self</span>.is_empty());
<span class="kw">let </span>byte = <span class="self">self</span>.as_slice()[<span class="number">0</span>];
<span class="self">self</span>.advance(<span class="number">1</span>);
byte
}
<span class="doccomment">/// Reads an `u64` encoded as little-endian from the `OwnedBytes` and advance by 8 bytes.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>read_u64(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; u64 {
<span class="macro">assert!</span>(<span class="self">self</span>.len() &gt; <span class="number">7</span>);
<span class="kw">let </span>octlet: [u8; <span class="number">8</span>] = <span class="self">self</span>.as_slice()[..<span class="number">8</span>].try_into().unwrap();
<span class="self">self</span>.advance(<span class="number">8</span>);
u64::from_le_bytes(octlet)
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>OwnedBytes {
<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) -&gt; fmt::Result {
<span class="comment">// We truncate the bytes in order to make sure the debug string
// is not too long.
</span><span class="kw">let </span>bytes_truncated: <span class="kw-2">&amp;</span>[u8] = <span class="kw">if </span><span class="self">self</span>.len() &gt; <span class="number">8 </span>{
<span class="kw-2">&amp;</span><span class="self">self</span>.as_slice()[..<span class="number">10</span>]
} <span class="kw">else </span>{
<span class="self">self</span>.as_slice()
};
<span class="macro">write!</span>(f, <span class="string">&quot;OwnedBytes({:?}, len={})&quot;</span>, bytes_truncated, <span class="self">self</span>.len())
}
}
<span class="kw">impl </span>PartialEq <span class="kw">for </span>OwnedBytes {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span>OwnedBytes) -&gt; bool {
<span class="self">self</span>.as_slice() == other.as_slice()
}
}
<span class="kw">impl </span>Eq <span class="kw">for </span>OwnedBytes {}
<span class="kw">impl </span>PartialEq&lt;[u8]&gt; <span class="kw">for </span>OwnedBytes {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span>[u8]) -&gt; bool {
<span class="self">self</span>.as_slice() == other
}
}
<span class="kw">impl </span>PartialEq&lt;str&gt; <span class="kw">for </span>OwnedBytes {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span>str) -&gt; bool {
<span class="self">self</span>.as_slice() == other.as_bytes()
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: <span class="question-mark">?</span>Sized&gt; PartialEq&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>T&gt; <span class="kw">for </span>OwnedBytes
<span class="kw">where </span>OwnedBytes: PartialEq&lt;T&gt;
{
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, other: &amp;&amp;<span class="lifetime">&#39;a </span>T) -&gt; bool {
<span class="kw-2">*</span><span class="self">self </span>== <span class="kw-2">**</span>other
}
}
<span class="kw">impl </span>Deref <span class="kw">for </span>OwnedBytes {
<span class="kw">type </span>Target = [u8];
<span class="attribute">#[inline]
</span><span class="kw">fn </span>deref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="self">Self</span>::Target {
<span class="self">self</span>.as_slice()
}
}
<span class="kw">impl </span>io::Read <span class="kw">for </span>OwnedBytes {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>read(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<span class="kw">let </span>read_len = {
<span class="kw">let </span>data = <span class="self">self</span>.as_slice();
<span class="kw">if </span>data.len() &gt;= buf.len() {
<span class="kw">let </span>buf_len = buf.len();
buf.copy_from_slice(<span class="kw-2">&amp;</span>data[..buf_len]);
buf.len()
} <span class="kw">else </span>{
<span class="kw">let </span>data_len = data.len();
buf[..data_len].copy_from_slice(data);
data_len
}
};
<span class="self">self</span>.advance(read_len);
<span class="prelude-val">Ok</span>(read_len)
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>read_to_end(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) -&gt; io::Result&lt;usize&gt; {
<span class="kw">let </span>read_len = {
<span class="kw">let </span>data = <span class="self">self</span>.as_slice();
buf.extend(data);
data.len()
};
<span class="self">self</span>.advance(read_len);
<span class="prelude-val">Ok</span>(read_len)
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>read_exact(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span>read_len = <span class="self">self</span>.read(buf)<span class="question-mark">?</span>;
<span class="kw">if </span>read_len != buf.len() {
<span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::new(
io::ErrorKind::UnexpectedEof,
<span class="string">&quot;failed to fill whole buffer&quot;</span>,
));
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">impl </span>AsRef&lt;[u8]&gt; <span class="kw">for </span>OwnedBytes {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>as_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[u8] {
<span class="self">self</span>.as_slice()
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>std::io::{<span class="self">self</span>, Read};
<span class="kw">use </span><span class="kw">super</span>::OwnedBytes;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_owned_bytes_debug() {
<span class="kw">let </span>short_bytes = OwnedBytes::new(<span class="string">b&quot;abcd&quot;</span>.as_ref());
<span class="macro">assert_eq!</span>(
<span class="macro">format!</span>(<span class="string">&quot;{:?}&quot;</span>, short_bytes),
<span class="string">&quot;OwnedBytes([97, 98, 99, 100], len=4)&quot;
</span>);
<span class="kw">let </span>long_bytes = OwnedBytes::new(<span class="string">b&quot;abcdefghijklmnopq&quot;</span>.as_ref());
<span class="macro">assert_eq!</span>(
<span class="macro">format!</span>(<span class="string">&quot;{:?}&quot;</span>, long_bytes),
<span class="string">&quot;OwnedBytes([97, 98, 99, 100, 101, 102, 103, 104, 105, 106], len=17)&quot;
</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_owned_bytes_read() -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>bytes = OwnedBytes::new(<span class="string">b&quot;abcdefghiklmnopqrstuvwxyz&quot;</span>.as_ref());
{
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0u8</span>; <span class="number">5</span>];
bytes.read_exact(<span class="kw-2">&amp;mut </span>buf[..]).unwrap();
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>buf, <span class="string">b&quot;abcde&quot;</span>);
<span class="macro">assert_eq!</span>(bytes.as_slice(), <span class="string">b&quot;fghiklmnopqrstuvwxyz&quot;</span>)
}
{
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0u8</span>; <span class="number">2</span>];
bytes.read_exact(<span class="kw-2">&amp;mut </span>buf[..]).unwrap();
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>buf, <span class="string">b&quot;fg&quot;</span>);
<span class="macro">assert_eq!</span>(bytes.as_slice(), <span class="string">b&quot;hiklmnopqrstuvwxyz&quot;</span>)
}
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_owned_bytes_read_right_at_the_end() -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>bytes = OwnedBytes::new(<span class="string">b&quot;abcde&quot;</span>.as_ref());
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0u8</span>; <span class="number">5</span>];
<span class="macro">assert_eq!</span>(bytes.read(<span class="kw-2">&amp;mut </span>buf[..]).unwrap(), <span class="number">5</span>);
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>buf, <span class="string">b&quot;abcde&quot;</span>);
<span class="macro">assert_eq!</span>(bytes.as_slice(), <span class="string">b&quot;&quot;</span>);
<span class="macro">assert_eq!</span>(bytes.read(<span class="kw-2">&amp;mut </span>buf[..]).unwrap(), <span class="number">0</span>);
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>buf, <span class="string">b&quot;abcde&quot;</span>);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_owned_bytes_read_incomplete() -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>bytes = OwnedBytes::new(<span class="string">b&quot;abcde&quot;</span>.as_ref());
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0u8</span>; <span class="number">7</span>];
<span class="macro">assert_eq!</span>(bytes.read(<span class="kw-2">&amp;mut </span>buf[..]).unwrap(), <span class="number">5</span>);
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>buf[..<span class="number">5</span>], <span class="string">b&quot;abcde&quot;</span>);
<span class="macro">assert_eq!</span>(bytes.read(<span class="kw-2">&amp;mut </span>buf[..]).unwrap(), <span class="number">0</span>);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_owned_bytes_read_to_end() -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>bytes = OwnedBytes::new(<span class="string">b&quot;abcde&quot;</span>.as_ref());
<span class="kw">let </span><span class="kw-2">mut </span>buf = Vec::new();
bytes.read_to_end(<span class="kw-2">&amp;mut </span>buf)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(buf.as_slice(), <span class="string">b&quot;abcde&quot;</span>.as_ref());
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_owned_bytes_read_u8() -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>bytes = OwnedBytes::new(<span class="string">b&quot;\xFF&quot;</span>.as_ref());
<span class="macro">assert_eq!</span>(bytes.read_u8(), <span class="number">255</span>);
<span class="macro">assert_eq!</span>(bytes.len(), <span class="number">0</span>);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_owned_bytes_read_u64() -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>bytes = OwnedBytes::new(<span class="string">b&quot;\0\xFF\xFF\xFF\xFF\xFF\xFF\xFF&quot;</span>.as_ref());
<span class="macro">assert_eq!</span>(bytes.read_u64(), u64::MAX - <span class="number">255</span>);
<span class="macro">assert_eq!</span>(bytes.len(), <span class="number">0</span>);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_owned_bytes_split() {
<span class="kw">let </span>bytes = OwnedBytes::new(<span class="string">b&quot;abcdefghi&quot;</span>.as_ref());
<span class="kw">let </span>(left, right) = bytes.split(<span class="number">3</span>);
<span class="macro">assert_eq!</span>(left.as_slice(), <span class="string">b&quot;abc&quot;</span>);
<span class="macro">assert_eq!</span>(right.as_slice(), <span class="string">b&quot;defghi&quot;</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_owned_bytes_split_boundary() {
<span class="kw">let </span>bytes = OwnedBytes::new(<span class="string">b&quot;abcdefghi&quot;</span>.as_ref());
{
<span class="kw">let </span>(left, right) = bytes.clone().split(<span class="number">0</span>);
<span class="macro">assert_eq!</span>(left.as_slice(), <span class="string">b&quot;&quot;</span>);
<span class="macro">assert_eq!</span>(right.as_slice(), <span class="string">b&quot;abcdefghi&quot;</span>);
}
{
<span class="kw">let </span>(left, right) = bytes.split(<span class="number">9</span>);
<span class="macro">assert_eq!</span>(left.as_slice(), <span class="string">b&quot;abcdefghi&quot;</span>);
<span class="macro">assert_eq!</span>(right.as_slice(), <span class="string">b&quot;&quot;</span>);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_split_off() {
<span class="kw">let </span><span class="kw-2">mut </span>data = OwnedBytes::new(<span class="string">b&quot;abcdef&quot;</span>.as_ref());
<span class="macro">assert_eq!</span>(data, <span class="string">&quot;abcdef&quot;</span>);
<span class="macro">assert_eq!</span>(data.split_off(<span class="number">2</span>), <span class="string">&quot;cdef&quot;</span>);
<span class="macro">assert_eq!</span>(data, <span class="string">&quot;ab&quot;</span>);
<span class="macro">assert_eq!</span>(data.split_off(<span class="number">1</span>), <span class="string">&quot;b&quot;</span>);
<span class="macro">assert_eq!</span>(data, <span class="string">&quot;a&quot;</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ownedbytes" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>