| <!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/query.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::fmt; |
| |
| <span class="kw">use </span>downcast_rs::impl_downcast; |
| |
| <span class="kw">use </span><span class="kw">super</span>::Weight; |
| <span class="kw">use </span><span class="kw">crate</span>::core::searcher::Searcher; |
| <span class="kw">use </span><span class="kw">crate</span>::query::Explanation; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::Schema; |
| <span class="kw">use crate</span>::{DocAddress, Term}; |
| |
| <span class="doccomment">/// Argument used in `Query::weight(..)` |
| </span><span class="attribute">#[derive(Copy, Clone)] |
| </span><span class="kw">pub enum </span>EnableScoring<<span class="lifetime">'a</span>> { |
| <span class="doccomment">/// Pass this to enable scoring. |
| </span>Enabled(<span class="kw-2">&</span><span class="lifetime">'a </span>Searcher), |
| <span class="doccomment">/// Pass this to disable scoring. |
| /// This can improve performance. |
| </span>Disabled(<span class="kw-2">&</span><span class="lifetime">'a </span>Schema), |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> EnableScoring<<span class="lifetime">'a</span>> { |
| <span class="doccomment">/// Returns the schema. |
| </span><span class="kw">pub fn </span>schema(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Schema { |
| <span class="kw">match </span><span class="self">self </span>{ |
| EnableScoring::Enabled(searcher) => searcher.schema(), |
| EnableScoring::Disabled(schema) => schema, |
| } |
| } |
| |
| <span class="doccomment">/// Returns true if the scoring is enabled. |
| </span><span class="kw">pub fn </span>is_scoring_enabled(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="kw">match </span><span class="self">self </span>{ |
| EnableScoring::Enabled(<span class="kw">_</span>) => <span class="bool-val">true</span>, |
| EnableScoring::Disabled(<span class="kw">_</span>) => <span class="bool-val">false</span>, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// The `Query` trait defines a set of documents and a scoring method |
| /// for those documents. |
| /// |
| /// The `Query` trait is in charge of defining : |
| /// |
| /// - a set of documents |
| /// - a way to score these documents |
| /// |
| /// When performing a [search](Searcher::search), these documents will then |
| /// be pushed to a [`Collector`](crate::collector::Collector), |
| /// which will in turn be in charge of deciding what to do with them. |
| /// |
| /// Concretely, this scored docset is represented by the |
| /// [`Scorer`] trait. |
| /// |
| /// Because our index is actually split into segments, the |
| /// query does not actually directly creates [`DocSet`](crate::DocSet) object. |
| /// Instead, the query creates a [`Weight`] object for a given searcher. |
| /// |
| /// The weight object, in turn, makes it possible to create |
| /// a scorer for a specific [`SegmentReader`]. |
| /// |
| /// So to sum it up : |
| /// - a `Query` is a recipe to define a set of documents as well the way to score them. |
| /// - a [`Weight`] is this recipe tied to a specific [`Searcher`]. It may for instance |
| /// hold statistics about the different term of the query. It is created by the query. |
| /// - a [`Scorer`] is a cursor over the set of matching documents, for a specific |
| /// [`SegmentReader`]. It is created by the [`Weight`]. |
| /// |
| /// When implementing a new type of `Query`, it is normal to implement a |
| /// dedicated `Query`, [`Weight`] and [`Scorer`]. |
| /// |
| /// [`Scorer`]: crate::query::Scorer |
| /// [`SegmentReader`]: crate::SegmentReader |
| </span><span class="kw">pub trait </span>Query: QueryClone + Send + Sync + downcast_rs::Downcast + fmt::Debug { |
| <span class="doccomment">/// Create the weight associated with a query. |
| /// |
| /// If scoring is not required, setting `scoring_enabled` to `false` |
| /// can increase performances. |
| /// |
| /// See [`Weight`]. |
| </span><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="doccomment">/// Returns an `Explanation` for the score of the document. |
| </span><span class="kw">fn </span>explain(<span class="kw-2">&</span><span class="self">self</span>, searcher: <span class="kw-2">&</span>Searcher, doc_address: DocAddress) -> <span class="kw">crate</span>::Result<Explanation> { |
| <span class="kw">let </span>weight = <span class="self">self</span>.weight(EnableScoring::Enabled(searcher))<span class="question-mark">?</span>; |
| <span class="kw">let </span>reader = searcher.segment_reader(doc_address.segment_ord); |
| weight.explain(reader, doc_address.doc_id) |
| } |
| |
| <span class="doccomment">/// Returns the number of documents matching the query. |
| </span><span class="kw">fn </span>count(<span class="kw-2">&</span><span class="self">self</span>, searcher: <span class="kw-2">&</span>Searcher) -> <span class="kw">crate</span>::Result<usize> { |
| <span class="kw">let </span>weight = <span class="self">self</span>.weight(EnableScoring::Disabled(searcher.schema()))<span class="question-mark">?</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>result = <span class="number">0</span>; |
| <span class="kw">for </span>reader <span class="kw">in </span>searcher.segment_readers() { |
| result += weight.count(reader)<span class="question-mark">? </span><span class="kw">as </span>usize; |
| } |
| <span class="prelude-val">Ok</span>(result) |
| } |
| |
| <span class="doccomment">/// Extract all of the terms associated with the query and pass them to the |
| /// given closure. |
| /// |
| /// Each term is associated with a boolean indicating whether |
| /// positions are required or not. |
| /// |
| /// Note that there can be multiple instances of any given term |
| /// in a query and deduplication must be handled by the visitor. |
| </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)) {} |
| } |
| |
| <span class="doccomment">/// Implements `box_clone`. |
| </span><span class="kw">pub trait </span>QueryClone { |
| <span class="doccomment">/// Returns a boxed clone of `self`. |
| </span><span class="kw">fn </span>box_clone(<span class="kw-2">&</span><span class="self">self</span>) -> Box<<span class="kw">dyn </span>Query>; |
| } |
| |
| <span class="kw">impl</span><T> QueryClone <span class="kw">for </span>T |
| <span class="kw">where </span>T: <span class="lifetime">'static </span>+ Query + Clone |
| { |
| <span class="kw">fn </span>box_clone(<span class="kw-2">&</span><span class="self">self</span>) -> Box<<span class="kw">dyn </span>Query> { |
| Box::new(<span class="self">self</span>.clone()) |
| } |
| } |
| |
| <span class="kw">impl </span>Query <span class="kw">for </span>Box<<span class="kw">dyn </span>Query> { |
| <span class="kw">fn </span>weight(<span class="kw-2">&</span><span class="self">self</span>, enabled_scoring: EnableScoring) -> <span class="kw">crate</span>::Result<Box<<span class="kw">dyn </span>Weight>> { |
| <span class="self">self</span>.as_ref().weight(enabled_scoring) |
| } |
| |
| <span class="kw">fn </span>count(<span class="kw-2">&</span><span class="self">self</span>, searcher: <span class="kw-2">&</span>Searcher) -> <span class="kw">crate</span>::Result<usize> { |
| <span class="self">self</span>.as_ref().count(searcher) |
| } |
| |
| <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)) { |
| <span class="self">self</span>.as_ref().query_terms(visitor); |
| } |
| } |
| |
| <span class="kw">impl </span>QueryClone <span class="kw">for </span>Box<<span class="kw">dyn </span>Query> { |
| <span class="kw">fn </span>box_clone(<span class="kw-2">&</span><span class="self">self</span>) -> Box<<span class="kw">dyn </span>Query> { |
| <span class="self">self</span>.as_ref().box_clone() |
| } |
| } |
| |
| <span class="macro">impl_downcast!</span>(Query); |
| </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> |
