| <!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/query/term_query/term_query.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>term_query.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::fmt; |
| |
| <span class="kw">use </span><span class="kw">super</span>::term_weight::TermWeight; |
| <span class="kw">use </span><span class="kw">crate</span>::query::bm25::Bm25Weight; |
| <span class="kw">use </span><span class="kw">crate</span>::query::{EnableScoring, Explanation, Query, Weight}; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::IndexRecordOption; |
| <span class="kw">use </span><span class="kw">crate</span>::Term; |
| |
| <span class="doccomment">/// A Term query matches all of the documents |
| /// containing a specific term. |
| /// |
| /// The score associated is defined as |
| /// `idf` * sqrt(`term_freq` / `field norm`) |
| /// in which : |
| /// * `idf` - inverse document frequency. |
| /// * `term_freq` - number of occurrences of the term in the field |
| /// * `field norm` - number of tokens in the field. |
| /// |
| /// ```rust |
| /// use tantivy::collector::{Count, TopDocs}; |
| /// use tantivy::query::TermQuery; |
| /// use tantivy::schema::{Schema, TEXT, IndexRecordOption}; |
| /// use tantivy::{doc, Index, Term}; |
| /// # fn test() -> tantivy::Result<()> { |
| /// let mut schema_builder = Schema::builder(); |
| /// let title = schema_builder.add_text_field("title", TEXT); |
| /// let schema = schema_builder.build(); |
| /// let index = Index::create_in_ram(schema); |
| /// { |
| /// let mut index_writer = index.writer(3_000_000)?; |
| /// index_writer.add_document(doc!( |
| /// title => "The Name of the Wind", |
| /// ))?; |
| /// index_writer.add_document(doc!( |
| /// title => "The Diary of Muadib", |
| /// ))?; |
| /// index_writer.add_document(doc!( |
| /// title => "A Dairy Cow", |
| /// ))?; |
| /// index_writer.add_document(doc!( |
| /// title => "The Diary of a Young Girl", |
| /// ))?; |
| /// index_writer.commit()?; |
| /// } |
| /// let reader = index.reader()?; |
| /// let searcher = reader.searcher(); |
| /// let query = TermQuery::new( |
| /// Term::from_field_text(title, "diary"), |
| /// IndexRecordOption::Basic, |
| /// ); |
| /// let (top_docs, count) = searcher.search(&query, &(TopDocs::with_limit(2), Count))?; |
| /// assert_eq!(count, 2); |
| /// Ok(()) |
| /// # } |
| /// # assert!(test().is_ok()); |
| /// ``` |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>TermQuery { |
| term: Term, |
| index_record_option: IndexRecordOption, |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>TermQuery { |
| <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">"TermQuery({:?})"</span>, <span class="self">self</span>.term) |
| } |
| } |
| |
| <span class="kw">impl </span>TermQuery { |
| <span class="doccomment">/// Creates a new term query. |
| </span><span class="kw">pub fn </span>new(term: Term, segment_postings_options: IndexRecordOption) -> TermQuery { |
| TermQuery { |
| term, |
| index_record_option: segment_postings_options, |
| } |
| } |
| |
| <span class="doccomment">/// The `Term` this query is built out of. |
| </span><span class="kw">pub fn </span>term(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Term { |
| <span class="kw-2">&</span><span class="self">self</span>.term |
| } |
| |
| <span class="doccomment">/// Returns a weight object. |
| /// |
| /// While `.weight(...)` returns a boxed trait object, |
| /// this method return a specific implementation. |
| /// This is useful for optimization purpose. |
| </span><span class="kw">pub fn </span>specialized_weight( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| enable_scoring: EnableScoring<<span class="lifetime">'_</span>>, |
| ) -> <span class="kw">crate</span>::Result<TermWeight> { |
| <span class="kw">let </span>schema = enable_scoring.schema(); |
| <span class="kw">let </span>field_entry = schema.get_field_entry(<span class="self">self</span>.term.field()); |
| <span class="kw">if </span>!field_entry.is_indexed() { |
| <span class="kw">let </span>error_msg = <span class="macro">format!</span>(<span class="string">"Field {:?} is not indexed."</span>, field_entry.name()); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="kw">crate</span>::TantivyError::SchemaError(error_msg)); |
| } |
| <span class="kw">let </span>bm25_weight = <span class="kw">match </span>enable_scoring { |
| EnableScoring::Enabled(searcher) => { |
| Bm25Weight::for_terms(searcher, <span class="kw-2">&</span>[<span class="self">self</span>.term.clone()])<span class="question-mark">? |
| </span>} |
| EnableScoring::Disabled(_schema) => { |
| Bm25Weight::new(Explanation::new(<span class="string">"<no score>"</span>.to_string(), <span class="number">1.0f32</span>), <span class="number">1.0f32</span>) |
| } |
| }; |
| <span class="kw">let </span>scoring_enabled = enable_scoring.is_scoring_enabled(); |
| <span class="kw">let </span>index_record_option = <span class="kw">if </span>scoring_enabled { |
| <span class="self">self</span>.index_record_option |
| } <span class="kw">else </span>{ |
| IndexRecordOption::Basic |
| }; |
| <span class="prelude-val">Ok</span>(TermWeight::new( |
| <span class="self">self</span>.term.clone(), |
| index_record_option, |
| bm25_weight, |
| scoring_enabled, |
| )) |
| } |
| } |
| |
| <span class="kw">impl </span>Query <span class="kw">for </span>TermQuery { |
| <span class="kw">fn </span>weight(<span class="kw-2">&</span><span class="self">self</span>, enable_scoring: EnableScoring<<span class="lifetime">'_</span>>) -> <span class="kw">crate</span>::Result<Box<<span class="kw">dyn </span>Weight>> { |
| <span class="prelude-val">Ok</span>(Box::new(<span class="self">self</span>.specialized_weight(enable_scoring)<span class="question-mark">?</span>)) |
| } |
| <span class="kw">fn </span>query_terms<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, visitor: <span class="kw-2">&mut </span><span class="kw">dyn </span>FnMut(<span class="kw-2">&</span><span class="lifetime">'a </span>Term, bool)) { |
| visitor(<span class="kw-2">&</span><span class="self">self</span>.term, <span class="bool-val">false</span>); |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>std::net::{IpAddr, Ipv6Addr}; |
| <span class="kw">use </span>std::str::FromStr; |
| |
| <span class="kw">use </span>fastfield_codecs::MonotonicallyMappableToU128; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::collector::{Count, TopDocs}; |
| <span class="kw">use </span><span class="kw">crate</span>::query::{Query, QueryParser, TermQuery}; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::{IndexRecordOption, IntoIpv6Addr, Schema, INDEXED, STORED}; |
| <span class="kw">use crate</span>::{doc, Index, Term}; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>search_ip_test() { |
| <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder(); |
| <span class="kw">let </span>ip_field = schema_builder.add_ip_addr_field(<span class="string">"ip"</span>, INDEXED | STORED); |
| <span class="kw">let </span>schema = schema_builder.build(); |
| <span class="kw">let </span>index = Index::create_in_ram(schema); |
| <span class="kw">let </span>ip_addr_1 = IpAddr::from_str(<span class="string">"127.0.0.1"</span>).unwrap().into_ipv6_addr(); |
| <span class="kw">let </span>ip_addr_2 = Ipv6Addr::from_u128(<span class="number">10</span>); |
| |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer(<span class="number">3_000_000</span>).unwrap(); |
| index_writer |
| .add_document(<span class="macro">doc!</span>( |
| ip_field => ip_addr_1 |
| )) |
| .unwrap(); |
| index_writer |
| .add_document(<span class="macro">doc!</span>( |
| ip_field => ip_addr_2 |
| )) |
| .unwrap(); |
| |
| index_writer.commit().unwrap(); |
| } |
| <span class="kw">let </span>reader = index.reader().unwrap(); |
| <span class="kw">let </span>searcher = reader.searcher(); |
| |
| <span class="kw">let </span>assert_single_hit = |query| { |
| <span class="kw">let </span>(_top_docs, count) = searcher |
| .search(<span class="kw-2">&</span>query, <span class="kw-2">&</span>(TopDocs::with_limit(<span class="number">2</span>), Count)) |
| .unwrap(); |
| <span class="macro">assert_eq!</span>(count, <span class="number">1</span>); |
| }; |
| <span class="kw">let </span>query_from_text = |text: String| { |
| QueryParser::for_index(<span class="kw-2">&</span>index, <span class="macro">vec!</span>[ip_field]) |
| .parse_query(<span class="kw-2">&</span>text) |
| .unwrap() |
| }; |
| |
| <span class="kw">let </span>query_from_ip = |ip_addr| -> Box<<span class="kw">dyn </span>Query> { |
| Box::new(TermQuery::new( |
| Term::from_field_ip_addr(ip_field, ip_addr), |
| IndexRecordOption::Basic, |
| )) |
| }; |
| |
| assert_single_hit(query_from_ip(ip_addr_1)); |
| assert_single_hit(query_from_ip(ip_addr_2)); |
| assert_single_hit(query_from_text(<span class="string">"127.0.0.1"</span>.to_string())); |
| assert_single_hit(query_from_text(<span class="string">"\"127.0.0.1\""</span>.to_string())); |
| assert_single_hit(query_from_text(<span class="macro">format!</span>(<span class="string">"\"{}\""</span>, ip_addr_1))); |
| assert_single_hit(query_from_text(<span class="macro">format!</span>(<span class="string">"\"{}\""</span>, ip_addr_2))); |
| } |
| } |
| </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> |
