| <!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/const_score_query.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>const_score_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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::fmt; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::query::{EnableScoring, Explanation, Query, Scorer, Weight}; |
| <span class="kw">use crate</span>::{DocId, DocSet, Score, SegmentReader, TantivyError, Term}; |
| |
| <span class="doccomment">/// `ConstScoreQuery` is a wrapper over a query to provide a constant score. |
| /// It can avoid unnecessary score computation on the wrapped query. |
| /// |
| /// The document set matched by the `ConstScoreQuery` is strictly the same as the underlying query. |
| /// The configured score is used for each document. |
| </span><span class="kw">pub struct </span>ConstScoreQuery { |
| query: Box<<span class="kw">dyn </span>Query>, |
| score: Score, |
| } |
| |
| <span class="kw">impl </span>ConstScoreQuery { |
| <span class="doccomment">/// Builds a const score query. |
| </span><span class="kw">pub fn </span>new(query: Box<<span class="kw">dyn </span>Query>, score: Score) -> ConstScoreQuery { |
| ConstScoreQuery { query, score } |
| } |
| } |
| |
| <span class="kw">impl </span>Clone <span class="kw">for </span>ConstScoreQuery { |
| <span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{ |
| ConstScoreQuery { |
| query: <span class="self">self</span>.query.box_clone(), |
| score: <span class="self">self</span>.score, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>ConstScoreQuery { |
| <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">"Const(score={}, query={:?})"</span>, <span class="self">self</span>.score, <span class="self">self</span>.query) |
| } |
| } |
| |
| <span class="kw">impl </span>Query <span class="kw">for </span>ConstScoreQuery { |
| <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="kw">let </span>inner_weight = <span class="self">self</span>.query.weight(enable_scoring)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(<span class="kw">if </span>enable_scoring.is_scoring_enabled() { |
| Box::new(ConstWeight::new(inner_weight, <span class="self">self</span>.score)) |
| } <span class="kw">else </span>{ |
| inner_weight |
| }) |
| } |
| |
| <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>.query.query_terms(visitor); |
| } |
| } |
| |
| <span class="kw">struct </span>ConstWeight { |
| weight: Box<<span class="kw">dyn </span>Weight>, |
| score: Score, |
| } |
| |
| <span class="kw">impl </span>ConstWeight { |
| <span class="kw">pub fn </span>new(weight: Box<<span class="kw">dyn </span>Weight>, score: Score) -> <span class="self">Self </span>{ |
| ConstWeight { weight, score } |
| } |
| } |
| |
| <span class="kw">impl </span>Weight <span class="kw">for </span>ConstWeight { |
| <span class="kw">fn </span>scorer(<span class="kw-2">&</span><span class="self">self</span>, reader: <span class="kw-2">&</span>SegmentReader, boost: Score) -> <span class="kw">crate</span>::Result<Box<<span class="kw">dyn </span>Scorer>> { |
| <span class="kw">let </span>inner_scorer = <span class="self">self</span>.weight.scorer(reader, boost)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(Box::new(ConstScorer::new(inner_scorer, boost * <span class="self">self</span>.score))) |
| } |
| |
| <span class="kw">fn </span>explain(<span class="kw-2">&</span><span class="self">self</span>, reader: <span class="kw-2">&</span>SegmentReader, doc: u32) -> <span class="kw">crate</span>::Result<Explanation> { |
| <span class="kw">let </span><span class="kw-2">mut </span>scorer = <span class="self">self</span>.scorer(reader, <span class="number">1.0</span>)<span class="question-mark">?</span>; |
| <span class="kw">if </span>scorer.seek(doc) != doc { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::InvalidArgument(<span class="macro">format!</span>( |
| <span class="string">"Document #({}) does not match"</span>, |
| doc |
| ))); |
| } |
| <span class="kw">let </span><span class="kw-2">mut </span>explanation = Explanation::new(<span class="string">"Const"</span>, <span class="self">self</span>.score); |
| <span class="kw">let </span>underlying_explanation = <span class="self">self</span>.weight.explain(reader, doc)<span class="question-mark">?</span>; |
| explanation.add_detail(underlying_explanation); |
| <span class="prelude-val">Ok</span>(explanation) |
| } |
| |
| <span class="kw">fn </span>count(<span class="kw-2">&</span><span class="self">self</span>, reader: <span class="kw-2">&</span>SegmentReader) -> <span class="kw">crate</span>::Result<u32> { |
| <span class="self">self</span>.weight.count(reader) |
| } |
| } |
| |
| <span class="doccomment">/// Wraps a `DocSet` and simply returns a constant `Scorer`. |
| /// The `ConstScorer` is useful if you have a `DocSet` where |
| /// you needed a scorer. |
| /// |
| /// The `ConstScorer`'s constant score can be set |
| /// by calling `.set_score(...)`. |
| </span><span class="kw">pub struct </span>ConstScorer<TDocSet: DocSet> { |
| docset: TDocSet, |
| score: Score, |
| } |
| |
| <span class="kw">impl</span><TDocSet: DocSet> ConstScorer<TDocSet> { |
| <span class="doccomment">/// Creates a new `ConstScorer`. |
| </span><span class="kw">pub fn </span>new(docset: TDocSet, score: Score) -> ConstScorer<TDocSet> { |
| ConstScorer { docset, score } |
| } |
| } |
| |
| <span class="kw">impl</span><TDocSet: DocSet> From<TDocSet> <span class="kw">for </span>ConstScorer<TDocSet> { |
| <span class="kw">fn </span>from(docset: TDocSet) -> <span class="self">Self </span>{ |
| ConstScorer::new(docset, <span class="number">1.0</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><TDocSet: DocSet> DocSet <span class="kw">for </span>ConstScorer<TDocSet> { |
| <span class="kw">fn </span>advance(<span class="kw-2">&mut </span><span class="self">self</span>) -> DocId { |
| <span class="self">self</span>.docset.advance() |
| } |
| |
| <span class="kw">fn </span>seek(<span class="kw-2">&mut </span><span class="self">self</span>, target: DocId) -> DocId { |
| <span class="self">self</span>.docset.seek(target) |
| } |
| |
| <span class="kw">fn </span>fill_buffer(<span class="kw-2">&mut </span><span class="self">self</span>, buffer: <span class="kw-2">&mut </span>[DocId]) -> usize { |
| <span class="self">self</span>.docset.fill_buffer(buffer) |
| } |
| |
| <span class="kw">fn </span>doc(<span class="kw-2">&</span><span class="self">self</span>) -> DocId { |
| <span class="self">self</span>.docset.doc() |
| } |
| |
| <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| <span class="self">self</span>.docset.size_hint() |
| } |
| } |
| |
| <span class="kw">impl</span><TDocSet: DocSet + <span class="lifetime">'static</span>> Scorer <span class="kw">for </span>ConstScorer<TDocSet> { |
| <span class="kw">fn </span>score(<span class="kw-2">&mut </span><span class="self">self</span>) -> Score { |
| <span class="self">self</span>.score |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span><span class="kw">super</span>::ConstScoreQuery; |
| <span class="kw">use </span><span class="kw">crate</span>::query::{AllQuery, Query}; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::Schema; |
| <span class="kw">use crate</span>::{DocAddress, Document, Index}; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_const_score_query_explain() -> <span class="kw">crate</span>::Result<()> { |
| <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><span class="kw-2">mut </span>index_writer = index.writer_for_tests()<span class="question-mark">?</span>; |
| index_writer.add_document(Document::new())<span class="question-mark">?</span>; |
| index_writer.commit()<span class="question-mark">?</span>; |
| <span class="kw">let </span>reader = index.reader()<span class="question-mark">?</span>; |
| <span class="kw">let </span>searcher = reader.searcher(); |
| <span class="kw">let </span>query = ConstScoreQuery::new(Box::new(AllQuery), <span class="number">0.42</span>); |
| <span class="kw">let </span>explanation = query.explain(<span class="kw-2">&</span>searcher, DocAddress::new(<span class="number">0</span>, <span class="number">0u32</span>)).unwrap(); |
| <span class="macro">assert_eq!</span>( |
| explanation.to_pretty_json(), |
| <span class="string">r#"{ |
| "value": 0.42, |
| "description": "Const", |
| "details": [ |
| { |
| "value": 1.0, |
| "description": "AllQuery", |
| "context": [] |
| } |
| ], |
| "context": [] |
| }"# |
| </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> |
