| <!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/src/directory/file_slice.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>file_slice.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="../../../tantivy/index.html"><div class="logo-container"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tantivy/index.html"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" 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> |
| </pre><pre class="rust"><code><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}; |
| |
| <span class="kw">use </span>async_trait::async_trait; |
| <span class="kw">use </span>common::HasLen; |
| <span class="kw">use </span>stable_deref_trait::StableDeref; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::directory::OwnedBytes; |
| |
| <span class="doccomment">/// Objects that represents files sections in tantivy. |
| /// |
| /// By contract, whatever happens to the directory file, as long as a FileHandle |
| /// is alive, the data associated with it cannot be altered or destroyed. |
| /// |
| /// The underlying behavior is therefore specific to the [`Directory`](crate::Directory) that |
| /// created it. Despite its name, a [`FileSlice`] may or may not directly map to an actual file |
| /// on the filesystem. |
| |
| </span><span class="attribute">#[async_trait] |
| </span><span class="kw">pub trait </span>FileHandle: <span class="lifetime">'static </span>+ Send + Sync + HasLen + fmt::Debug { |
| <span class="doccomment">/// Reads a slice of bytes. |
| /// |
| /// This method may panic if the range requested is invalid. |
| </span><span class="kw">fn </span>read_bytes(<span class="kw-2">&</span><span class="self">self</span>, range: Range<usize>) -> io::Result<OwnedBytes>; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"quickwit"</span>)] |
| #[doc(hidden)] |
| </span><span class="kw">async fn </span>read_bytes_async( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| _byte_range: Range<usize>, |
| ) -> <span class="kw">crate</span>::AsyncIoResult<OwnedBytes> { |
| <span class="prelude-val">Err</span>(<span class="kw">crate</span>::error::AsyncIoError::AsyncUnsupported) |
| } |
| } |
| |
| <span class="attribute">#[async_trait] |
| </span><span class="kw">impl </span>FileHandle <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'static </span>[u8] { |
| <span class="kw">fn </span>read_bytes(<span class="kw-2">&</span><span class="self">self</span>, range: Range<usize>) -> io::Result<OwnedBytes> { |
| <span class="kw">let </span>bytes = <span class="kw-2">&</span><span class="self">self</span>[range]; |
| <span class="prelude-val">Ok</span>(OwnedBytes::new(bytes)) |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"quickwit"</span>)] |
| </span><span class="kw">async fn </span>read_bytes_async(<span class="kw-2">&</span><span class="self">self</span>, byte_range: Range<usize>) -> <span class="kw">crate</span>::AsyncIoResult<OwnedBytes> { |
| <span class="prelude-val">Ok</span>(<span class="self">self</span>.read_bytes(byte_range)<span class="question-mark">?</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><B> From<B> <span class="kw">for </span>FileSlice |
| <span class="kw">where </span>B: StableDeref + Deref<Target = [u8]> + <span class="lifetime">'static </span>+ Send + Sync |
| { |
| <span class="kw">fn </span>from(bytes: B) -> FileSlice { |
| FileSlice::new(Arc::new(OwnedBytes::new(bytes))) |
| } |
| } |
| |
| <span class="doccomment">/// Logical slice of read only file in tantivy. |
| /// |
| /// It can be cloned and sliced cheaply. |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>FileSlice { |
| data: Arc<<span class="kw">dyn </span>FileHandle>, |
| range: Range<usize>, |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>FileSlice { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="macro">write!</span>(f, <span class="string">"FileSlice({:?}, {:?})"</span>, <span class="kw-2">&</span><span class="self">self</span>.data, <span class="self">self</span>.range) |
| } |
| } |
| |
| <span class="kw">impl </span>FileSlice { |
| <span class="doccomment">/// Wraps a FileHandle. |
| </span><span class="kw">pub fn </span>new(file_handle: Arc<<span class="kw">dyn </span>FileHandle>) -> <span class="self">Self </span>{ |
| <span class="kw">let </span>num_bytes = file_handle.len(); |
| FileSlice::new_with_num_bytes(file_handle, num_bytes) |
| } |
| |
| <span class="doccomment">/// Wraps a FileHandle. |
| </span><span class="attribute">#[doc(hidden)] |
| #[must_use] |
| </span><span class="kw">pub fn </span>new_with_num_bytes(file_handle: Arc<<span class="kw">dyn </span>FileHandle>, num_bytes: usize) -> <span class="self">Self </span>{ |
| FileSlice { |
| data: file_handle, |
| range: <span class="number">0</span>..num_bytes, |
| } |
| } |
| |
| <span class="doccomment">/// Creates a fileslice that is just a view over a slice of the data. |
| /// |
| /// # Panics |
| /// |
| /// Panics if `byte_range.end` exceeds the filesize. |
| </span><span class="attribute">#[must_use] |
| </span><span class="kw">pub fn </span>slice(<span class="kw-2">&</span><span class="self">self</span>, byte_range: Range<usize>) -> FileSlice { |
| <span class="macro">assert!</span>(byte_range.end <= <span class="self">self</span>.len()); |
| FileSlice { |
| data: <span class="self">self</span>.data.clone(), |
| range: <span class="self">self</span>.range.start + byte_range.start..<span class="self">self</span>.range.start + byte_range.end, |
| } |
| } |
| |
| <span class="doccomment">/// Creates an empty FileSlice |
| </span><span class="kw">pub fn </span>empty() -> FileSlice { |
| <span class="kw">const </span>EMPTY_SLICE: <span class="kw-2">&</span>[u8] = <span class="kw-2">&</span>[]; |
| FileSlice::from(EMPTY_SLICE) |
| } |
| |
| <span class="doccomment">/// Returns a `OwnedBytes` with all of the data in the `FileSlice`. |
| /// |
| /// The behavior is strongly dependent on the implementation of the underlying |
| /// `Directory` and the `FileSliceTrait` it creates. |
| /// In particular, it is up to the `Directory` implementation |
| /// to handle caching if needed. |
| </span><span class="kw">pub fn </span>read_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<OwnedBytes> { |
| <span class="self">self</span>.data.read_bytes(<span class="self">self</span>.range.clone()) |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"quickwit"</span>)] |
| #[doc(hidden)] |
| </span><span class="kw">pub async fn </span>read_bytes_async(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">crate</span>::AsyncIoResult<OwnedBytes> { |
| <span class="self">self</span>.data.read_bytes_async(<span class="self">self</span>.range.clone()).<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Reads a specific slice of data. |
| /// |
| /// This is equivalent to running `file_slice.slice(from, to).read_bytes()`. |
| </span><span class="kw">pub fn </span>read_bytes_slice(<span class="kw-2">&</span><span class="self">self</span>, range: Range<usize>) -> io::Result<OwnedBytes> { |
| <span class="macro">assert!</span>( |
| range.end <= <span class="self">self</span>.len(), |
| <span class="string">"end of requested range exceeds the fileslice length ({} > {})"</span>, |
| range.end, |
| <span class="self">self</span>.len() |
| ); |
| <span class="self">self</span>.data |
| .read_bytes(<span class="self">self</span>.range.start + range.start..<span class="self">self</span>.range.start + range.end) |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"quickwit"</span>)] |
| #[doc(hidden)] |
| </span><span class="kw">pub async fn </span>read_bytes_slice_async( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| byte_range: Range<usize>, |
| ) -> <span class="kw">crate</span>::AsyncIoResult<OwnedBytes> { |
| <span class="macro">assert!</span>( |
| <span class="self">self</span>.range.start + byte_range.end <= <span class="self">self</span>.range.end, |
| <span class="string">"`to` exceeds the fileslice length" |
| </span>); |
| <span class="self">self</span>.data |
| .read_bytes_async( |
| <span class="self">self</span>.range.start + byte_range.start..<span class="self">self</span>.range.start + byte_range.end, |
| ) |
| .<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Splits the FileSlice at the given offset and return two file slices. |
| /// `file_slice[..split_offset]` and `file_slice[split_offset..]`. |
| /// |
| /// This operation is cheap and must not copy any underlying data. |
| </span><span class="kw">pub fn </span>split(<span class="self">self</span>, left_len: usize) -> (FileSlice, FileSlice) { |
| <span class="kw">let </span>left = <span class="self">self</span>.slice_to(left_len); |
| <span class="kw">let </span>right = <span class="self">self</span>.slice_from(left_len); |
| (left, right) |
| } |
| |
| <span class="doccomment">/// Splits the file slice at the given offset and return two file slices. |
| /// `file_slice[..split_offset]` and `file_slice[split_offset..]`. |
| </span><span class="kw">pub fn </span>split_from_end(<span class="self">self</span>, right_len: usize) -> (FileSlice, FileSlice) { |
| <span class="kw">let </span>left_len = <span class="self">self</span>.len() - right_len; |
| <span class="self">self</span>.split(left_len) |
| } |
| |
| <span class="doccomment">/// Like `.slice(...)` but enforcing only the `from` |
| /// boundary. |
| /// |
| /// Equivalent to `.slice(from_offset, self.len())` |
| </span><span class="attribute">#[must_use] |
| </span><span class="kw">pub fn </span>slice_from(<span class="kw-2">&</span><span class="self">self</span>, from_offset: usize) -> FileSlice { |
| <span class="self">self</span>.slice(from_offset..<span class="self">self</span>.len()) |
| } |
| |
| <span class="doccomment">/// Returns a slice from the end. |
| /// |
| /// Equivalent to `.slice(self.len() - from_offset, self.len())` |
| </span><span class="attribute">#[must_use] |
| </span><span class="kw">pub fn </span>slice_from_end(<span class="kw-2">&</span><span class="self">self</span>, from_offset: usize) -> FileSlice { |
| <span class="self">self</span>.slice(<span class="self">self</span>.len() - from_offset..<span class="self">self</span>.len()) |
| } |
| |
| <span class="doccomment">/// Like `.slice(...)` but enforcing only the `to` |
| /// boundary. |
| /// |
| /// Equivalent to `.slice(0, to_offset)` |
| </span><span class="attribute">#[must_use] |
| </span><span class="kw">pub fn </span>slice_to(<span class="kw-2">&</span><span class="self">self</span>, to_offset: usize) -> FileSlice { |
| <span class="self">self</span>.slice(<span class="number">0</span>..to_offset) |
| } |
| } |
| |
| <span class="attribute">#[async_trait] |
| </span><span class="kw">impl </span>FileHandle <span class="kw">for </span>FileSlice { |
| <span class="kw">fn </span>read_bytes(<span class="kw-2">&</span><span class="self">self</span>, range: Range<usize>) -> io::Result<OwnedBytes> { |
| <span class="self">self</span>.read_bytes_slice(range) |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"quickwit"</span>)] |
| </span><span class="kw">async fn </span>read_bytes_async(<span class="kw-2">&</span><span class="self">self</span>, byte_range: Range<usize>) -> <span class="kw">crate</span>::AsyncIoResult<OwnedBytes> { |
| <span class="self">self</span>.read_bytes_slice_async(byte_range).<span class="kw">await |
| </span>} |
| } |
| |
| <span class="kw">impl </span>HasLen <span class="kw">for </span>FileSlice { |
| <span class="kw">fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.range.len() |
| } |
| } |
| |
| <span class="attribute">#[async_trait] |
| </span><span class="kw">impl </span>FileHandle <span class="kw">for </span>OwnedBytes { |
| <span class="kw">fn </span>read_bytes(<span class="kw-2">&</span><span class="self">self</span>, range: Range<usize>) -> io::Result<OwnedBytes> { |
| <span class="prelude-val">Ok</span>(<span class="self">self</span>.slice(range)) |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"quickwit"</span>)] |
| </span><span class="kw">async fn </span>read_bytes_async(<span class="kw-2">&</span><span class="self">self</span>, range: Range<usize>) -> <span class="kw">crate</span>::AsyncIoResult<OwnedBytes> { |
| <span class="kw">let </span>bytes = <span class="self">self</span>.read_bytes(range)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(bytes) |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">use </span>common::HasLen; |
| |
| <span class="kw">use super</span>::{FileHandle, FileSlice}; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_file_slice() -> io::Result<()> { |
| <span class="kw">let </span>file_slice = FileSlice::new(Arc::new(<span class="string">b"abcdef"</span>.as_ref())); |
| <span class="macro">assert_eq!</span>(file_slice.len(), <span class="number">6</span>); |
| <span class="macro">assert_eq!</span>(file_slice.slice_from(<span class="number">2</span>).read_bytes()<span class="question-mark">?</span>.as_slice(), <span class="string">b"cdef"</span>); |
| <span class="macro">assert_eq!</span>(file_slice.slice_to(<span class="number">2</span>).read_bytes()<span class="question-mark">?</span>.as_slice(), <span class="string">b"ab"</span>); |
| <span class="macro">assert_eq!</span>( |
| file_slice |
| .slice_from(<span class="number">1</span>) |
| .slice_to(<span class="number">2</span>) |
| .read_bytes()<span class="question-mark">? |
| </span>.as_slice(), |
| <span class="string">b"bc" |
| </span>); |
| { |
| <span class="kw">let </span>(left, right) = file_slice.clone().split(<span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(left.read_bytes()<span class="question-mark">?</span>.as_slice(), <span class="string">b""</span>); |
| <span class="macro">assert_eq!</span>(right.read_bytes()<span class="question-mark">?</span>.as_slice(), <span class="string">b"abcdef"</span>); |
| } |
| { |
| <span class="kw">let </span>(left, right) = file_slice.clone().split(<span class="number">2</span>); |
| <span class="macro">assert_eq!</span>(left.read_bytes()<span class="question-mark">?</span>.as_slice(), <span class="string">b"ab"</span>); |
| <span class="macro">assert_eq!</span>(right.read_bytes()<span class="question-mark">?</span>.as_slice(), <span class="string">b"cdef"</span>); |
| } |
| { |
| <span class="kw">let </span>(left, right) = file_slice.clone().split_from_end(<span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(left.read_bytes()<span class="question-mark">?</span>.as_slice(), <span class="string">b"abcdef"</span>); |
| <span class="macro">assert_eq!</span>(right.read_bytes()<span class="question-mark">?</span>.as_slice(), <span class="string">b""</span>); |
| } |
| { |
| <span class="kw">let </span>(left, right) = file_slice.split_from_end(<span class="number">2</span>); |
| <span class="macro">assert_eq!</span>(left.read_bytes()<span class="question-mark">?</span>.as_slice(), <span class="string">b"abcd"</span>); |
| <span class="macro">assert_eq!</span>(right.read_bytes()<span class="question-mark">?</span>.as_slice(), <span class="string">b"ef"</span>); |
| } |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_file_slice_trait_slice_len() { |
| <span class="kw">let </span>blop: <span class="kw-2">&</span><span class="lifetime">'static </span>[u8] = <span class="string">b"abc"</span>; |
| <span class="kw">let </span>owned_bytes: Box<<span class="kw">dyn </span>FileHandle> = Box::new(blop); |
| <span class="macro">assert_eq!</span>(owned_bytes.len(), <span class="number">3</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_slice_simple_read() -> io::Result<()> { |
| <span class="kw">let </span>slice = FileSlice::new(Arc::new(<span class="kw-2">&</span><span class="string">b"abcdef"</span>[..])); |
| <span class="macro">assert_eq!</span>(slice.len(), <span class="number">6</span>); |
| <span class="macro">assert_eq!</span>(slice.read_bytes()<span class="question-mark">?</span>.as_ref(), <span class="string">b"abcdef"</span>); |
| <span class="macro">assert_eq!</span>(slice.slice(<span class="number">1</span>..<span class="number">4</span>).read_bytes()<span class="question-mark">?</span>.as_ref(), <span class="string">b"bcd"</span>); |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_slice_read_slice() -> io::Result<()> { |
| <span class="kw">let </span>slice_deref = FileSlice::new(Arc::new(<span class="kw-2">&</span><span class="string">b"abcdef"</span>[..])); |
| <span class="macro">assert_eq!</span>(slice_deref.read_bytes_slice(<span class="number">1</span>..<span class="number">4</span>)<span class="question-mark">?</span>.as_ref(), <span class="string">b"bcd"</span>); |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="attribute">#[test] |
| #[should_panic(expected = <span class="string">"end of requested range exceeds the fileslice length (10 > 6)"</span>)] |
| </span><span class="kw">fn </span>test_slice_read_slice_invalid_range_exceeds() { |
| <span class="kw">let </span>slice_deref = FileSlice::new(Arc::new(<span class="kw-2">&</span><span class="string">b"abcdef"</span>[..])); |
| <span class="macro">assert_eq!</span>( |
| slice_deref.read_bytes_slice(<span class="number">0</span>..<span class="number">10</span>).unwrap().as_ref(), |
| <span class="string">b"bcd" |
| </span>); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
