| <!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/fieldnorm/writer.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>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="../../../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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::cmp::Ordering; |
| <span class="kw">use </span>std::{io, iter}; |
| |
| <span class="kw">use super</span>::{fieldnorm_to_id, FieldNormsSerializer}; |
| <span class="kw">use </span><span class="kw">crate</span>::indexer::doc_id_mapping::DocIdMapping; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::{Field, Schema}; |
| <span class="kw">use </span><span class="kw">crate</span>::DocId; |
| |
| <span class="doccomment">/// The `FieldNormsWriter` is in charge of tracking the fieldnorm byte |
| /// of each document for each field with field norms. |
| /// |
| /// `FieldNormsWriter` stores a `Vec<u8>` for each tracked field, using a |
| /// byte per document per field. |
| </span><span class="kw">pub struct </span>FieldNormsWriter { |
| fieldnorms_buffers: Vec<<span class="prelude-ty">Option</span><Vec<u8>>>, |
| } |
| |
| <span class="kw">impl </span>FieldNormsWriter { |
| <span class="doccomment">/// Returns the fields that should have field norms computed |
| /// according to the given schema. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>fields_with_fieldnorm(schema: <span class="kw-2">&</span>Schema) -> Vec<Field> { |
| schema |
| .fields() |
| .filter_map(|(field, field_entry)| { |
| <span class="kw">if </span>field_entry.is_indexed() && field_entry.has_fieldnorms() { |
| <span class="prelude-val">Some</span>(field) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>} |
| }) |
| .collect::<Vec<<span class="kw">_</span>>>() |
| } |
| |
| <span class="doccomment">/// Initialize with state for tracking the field norm fields |
| /// specified in the schema. |
| </span><span class="kw">pub fn </span>for_schema(schema: <span class="kw-2">&</span>Schema) -> FieldNormsWriter { |
| <span class="kw">let </span><span class="kw-2">mut </span>fieldnorms_buffers: Vec<<span class="prelude-ty">Option</span><Vec<u8>>> = iter::repeat_with(|| <span class="prelude-val">None</span>) |
| .take(schema.num_fields()) |
| .collect(); |
| <span class="kw">for </span>field <span class="kw">in </span>FieldNormsWriter::fields_with_fieldnorm(schema) { |
| fieldnorms_buffers[field.field_id() <span class="kw">as </span>usize] = <span class="prelude-val">Some</span>(Vec::with_capacity(<span class="number">1_000</span>)); |
| } |
| FieldNormsWriter { fieldnorms_buffers } |
| } |
| |
| <span class="doccomment">/// The memory used inclusive childs |
| </span><span class="kw">pub fn </span>mem_usage(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.fieldnorms_buffers |
| .iter() |
| .flatten() |
| .map(|buf| buf.capacity()) |
| .sum() |
| } |
| <span class="doccomment">/// Ensure that all documents in 0..max_doc have a byte associated with them |
| /// in each of the fieldnorm vectors. |
| /// |
| /// Will extend with 0-bytes for documents that have not been seen. |
| </span><span class="kw">pub fn </span>fill_up_to_max_doc(<span class="kw-2">&mut </span><span class="self">self</span>, max_doc: DocId) { |
| <span class="kw">for </span>fieldnorms_buffer_opt <span class="kw">in </span><span class="self">self</span>.fieldnorms_buffers.iter_mut() { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(fieldnorms_buffer) = fieldnorms_buffer_opt.as_mut() { |
| fieldnorms_buffer.resize(max_doc <span class="kw">as </span>usize, <span class="number">0u8</span>); |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Set the fieldnorm byte for the given document for the given field. |
| /// |
| /// Will internally convert the u32 `fieldnorm` value to the appropriate byte |
| /// to approximate the field norm in less space. |
| /// |
| /// * doc - the document id |
| /// * field - the field being set |
| /// * fieldnorm - the number of terms present in document `doc` in field `field` |
| </span><span class="kw">pub fn </span>record(<span class="kw-2">&mut </span><span class="self">self</span>, doc: DocId, field: Field, fieldnorm: u32) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(fieldnorm_buffer) = <span class="self">self |
| </span>.fieldnorms_buffers |
| .get_mut(field.field_id() <span class="kw">as </span>usize) |
| .and_then(Option::as_mut) |
| { |
| <span class="kw">match </span>fieldnorm_buffer.len().cmp(<span class="kw-2">&</span>(doc <span class="kw">as </span>usize)) { |
| Ordering::Less => { |
| <span class="comment">// we fill intermediary `DocId` as having a fieldnorm of 0. |
| </span>fieldnorm_buffer.resize(doc <span class="kw">as </span>usize, <span class="number">0u8</span>); |
| } |
| Ordering::Equal => {} |
| Ordering::Greater => { |
| <span class="macro">panic!</span>(<span class="string">"Cannot register a given fieldnorm twice"</span>) |
| } |
| } |
| fieldnorm_buffer.push(fieldnorm_to_id(fieldnorm)); |
| } |
| } |
| |
| <span class="doccomment">/// Serialize the seen fieldnorm values to the serializer for all fields. |
| </span><span class="kw">pub fn </span>serialize( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| <span class="kw-2">mut </span>fieldnorms_serializer: FieldNormsSerializer, |
| doc_id_map: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>DocIdMapping>, |
| ) -> io::Result<()> { |
| <span class="kw">for </span>(field, fieldnorms_buffer) <span class="kw">in </span><span class="self">self</span>.fieldnorms_buffers.iter().enumerate().filter_map( |
| |(field_id, fieldnorms_buffer_opt)| { |
| fieldnorms_buffer_opt.as_ref().map(|fieldnorms_buffer| { |
| (Field::from_field_id(field_id <span class="kw">as </span>u32), fieldnorms_buffer) |
| }) |
| }, |
| ) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(doc_id_map) = doc_id_map { |
| <span class="kw">let </span>remapped_fieldnorm_buffer = doc_id_map.remap(fieldnorms_buffer); |
| fieldnorms_serializer.serialize_field(field, <span class="kw-2">&</span>remapped_fieldnorm_buffer)<span class="question-mark">?</span>; |
| } <span class="kw">else </span>{ |
| fieldnorms_serializer.serialize_field(field, fieldnorms_buffer)<span class="question-mark">?</span>; |
| } |
| } |
| fieldnorms_serializer.close()<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</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> |
