| <!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/postings/term_info.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>term_info.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::iter::ExactSizeIterator; |
| <span class="kw">use </span>std::ops::Range; |
| |
| <span class="kw">use </span>common::{BinarySerializable, FixedSize}; |
| |
| <span class="doccomment">/// `TermInfo` wraps the metadata associated with a Term. |
| /// It is segment-local. |
| </span><span class="attribute">#[derive(Debug, Default, Eq, PartialEq, Clone)] |
| </span><span class="kw">pub struct </span>TermInfo { |
| <span class="doccomment">/// Number of documents in the segment containing the term |
| </span><span class="kw">pub </span>doc_freq: u32, |
| <span class="doccomment">/// Byte range of the posting list within the postings (`.idx`) file. |
| </span><span class="kw">pub </span>postings_range: Range<usize>, |
| <span class="doccomment">/// Byte range of the positions of this terms in the positions (`.pos`) file. |
| </span><span class="kw">pub </span>positions_range: Range<usize>, |
| } |
| |
| <span class="kw">impl </span>TermInfo { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>posting_num_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| <span class="kw">let </span>num_bytes = <span class="self">self</span>.postings_range.len(); |
| <span class="macro">assert!</span>(num_bytes <= u32::MAX <span class="kw">as </span>usize); |
| num_bytes <span class="kw">as </span>u32 |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>positions_num_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| <span class="kw">let </span>num_bytes = <span class="self">self</span>.positions_range.len(); |
| <span class="macro">assert!</span>(num_bytes <= u32::MAX <span class="kw">as </span>usize); |
| num_bytes <span class="kw">as </span>u32 |
| } |
| } |
| |
| <span class="kw">impl </span>FixedSize <span class="kw">for </span>TermInfo { |
| <span class="doccomment">/// Size required for the binary serialization of a `TermInfo` object. |
| /// This is large, but in practise, `TermInfo` are encoded in blocks and |
| /// only the first `TermInfo` of a block is serialized uncompressed. |
| /// The subsequent `TermInfo` are delta encoded and bitpacked. |
| </span><span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">3 </span>* u32::SIZE_IN_BYTES + <span class="number">2 </span>* u64::SIZE_IN_BYTES; |
| } |
| |
| <span class="kw">impl </span>BinarySerializable <span class="kw">for </span>TermInfo { |
| <span class="kw">fn </span>serialize<W: io::Write>(<span class="kw-2">&</span><span class="self">self</span>, writer: <span class="kw-2">&mut </span>W) -> io::Result<()> { |
| <span class="self">self</span>.doc_freq.serialize(writer)<span class="question-mark">?</span>; |
| (<span class="self">self</span>.postings_range.start <span class="kw">as </span>u64).serialize(writer)<span class="question-mark">?</span>; |
| <span class="self">self</span>.posting_num_bytes().serialize(writer)<span class="question-mark">?</span>; |
| (<span class="self">self</span>.positions_range.start <span class="kw">as </span>u64).serialize(writer)<span class="question-mark">?</span>; |
| <span class="self">self</span>.positions_num_bytes().serialize(writer)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="kw">fn </span>deserialize<R: io::Read>(reader: <span class="kw-2">&mut </span>R) -> io::Result<<span class="self">Self</span>> { |
| <span class="kw">let </span>doc_freq = u32::deserialize(reader)<span class="question-mark">?</span>; |
| <span class="kw">let </span>postings_start_offset = u64::deserialize(reader)<span class="question-mark">? </span><span class="kw">as </span>usize; |
| <span class="kw">let </span>postings_num_bytes = u32::deserialize(reader)<span class="question-mark">? </span><span class="kw">as </span>usize; |
| <span class="kw">let </span>postings_end_offset = postings_start_offset + postings_num_bytes; |
| <span class="kw">let </span>positions_start_offset = u64::deserialize(reader)<span class="question-mark">? </span><span class="kw">as </span>usize; |
| <span class="kw">let </span>positions_num_bytes = u32::deserialize(reader)<span class="question-mark">? </span><span class="kw">as </span>usize; |
| <span class="kw">let </span>positions_end_offset = positions_start_offset + positions_num_bytes; |
| <span class="prelude-val">Ok</span>(TermInfo { |
| doc_freq, |
| postings_range: postings_start_offset..postings_end_offset, |
| positions_range: positions_start_offset..positions_end_offset, |
| }) |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| |
| <span class="kw">use </span><span class="kw">super</span>::TermInfo; |
| <span class="kw">use </span><span class="kw">crate</span>::tests::fixed_size_test; |
| |
| <span class="comment">// TODO add serialize/deserialize test for terminfo |
| |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_fixed_size() { |
| fixed_size_test::<TermInfo>(); |
| } |
| } |
| </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> |
