| <!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/phrase_query/phrase_query.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>phrase_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> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::PhraseWeight; |
| <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, Query, Weight}; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::{Field, IndexRecordOption, Term}; |
| |
| <span class="doccomment">/// `PhraseQuery` matches a specific sequence of words. |
| /// |
| /// For instance the phrase query for `"part time"` will match |
| /// the sentence |
| /// |
| /// **Alan just got a part time job.** |
| /// |
| /// On the other hand it will not match the sentence. |
| /// |
| /// **This is my favorite part of the job.** |
| /// |
| /// [Slop](PhraseQuery::set_slop) allows leniency in term proximity |
| /// for some performance tradeof. |
| /// |
| /// Using a `PhraseQuery` on a field requires positions |
| /// to be indexed for this field. |
| </span><span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub struct </span>PhraseQuery { |
| field: Field, |
| phrase_terms: Vec<(usize, Term)>, |
| slop: u32, |
| } |
| |
| <span class="kw">impl </span>PhraseQuery { |
| <span class="doccomment">/// Creates a new `PhraseQuery` given a list of terms. |
| /// |
| /// There must be at least two terms, and all terms |
| /// must belong to the same field. |
| /// Offset for each term will be same as index in the Vector |
| </span><span class="kw">pub fn </span>new(terms: Vec<Term>) -> PhraseQuery { |
| <span class="kw">let </span>terms_with_offset = terms.into_iter().enumerate().collect(); |
| PhraseQuery::new_with_offset(terms_with_offset) |
| } |
| |
| <span class="doccomment">/// Creates a new `PhraseQuery` given a list of terms and their offsets. |
| /// |
| /// Can be used to provide custom offset for each term. |
| </span><span class="kw">pub fn </span>new_with_offset(terms: Vec<(usize, Term)>) -> PhraseQuery { |
| PhraseQuery::new_with_offset_and_slop(terms, <span class="number">0</span>) |
| } |
| |
| <span class="doccomment">/// Creates a new `PhraseQuery` given a list of terms, their offsets and a slop |
| </span><span class="kw">pub fn </span>new_with_offset_and_slop(<span class="kw-2">mut </span>terms: Vec<(usize, Term)>, slop: u32) -> PhraseQuery { |
| <span class="macro">assert!</span>( |
| terms.len() > <span class="number">1</span>, |
| <span class="string">"A phrase query is required to have strictly more than one term." |
| </span>); |
| terms.sort_by_key(|<span class="kw-2">&</span>(offset, <span class="kw">_</span>)| offset); |
| <span class="kw">let </span>field = terms[<span class="number">0</span>].<span class="number">1</span>.field(); |
| <span class="macro">assert!</span>( |
| terms[<span class="number">1</span>..].iter().all(|term| term.<span class="number">1</span>.field() == field), |
| <span class="string">"All terms from a phrase query must belong to the same field" |
| </span>); |
| PhraseQuery { |
| field, |
| phrase_terms: terms, |
| slop, |
| } |
| } |
| |
| <span class="doccomment">/// Slop allowed for the phrase. |
| /// |
| /// The query will match if its terms are separated by `slop` terms at most. |
| /// By default the slop is 0 meaning query terms need to be adjacent. |
| </span><span class="kw">pub fn </span>set_slop(<span class="kw-2">&mut </span><span class="self">self</span>, value: u32) { |
| <span class="self">self</span>.slop = value; |
| } |
| |
| <span class="doccomment">/// The [`Field`] this `PhraseQuery` is targeting. |
| </span><span class="kw">pub fn </span>field(<span class="kw-2">&</span><span class="self">self</span>) -> Field { |
| <span class="self">self</span>.field |
| } |
| |
| <span class="doccomment">/// `Term`s in the phrase without the associated offsets. |
| </span><span class="kw">pub fn </span>phrase_terms(<span class="kw-2">&</span><span class="self">self</span>) -> Vec<Term> { |
| <span class="self">self</span>.phrase_terms |
| .iter() |
| .map(|(<span class="kw">_</span>, term)| term.clone()) |
| .collect::<Vec<Term>>() |
| } |
| |
| <span class="doccomment">/// Returns the [`PhraseWeight`] for the given phrase query given a specific `searcher`. |
| /// |
| /// This function is the same as [`Query::weight()`] except it returns |
| /// a specialized type [`PhraseWeight`] instead of a Boxed trait. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>phrase_weight( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| enable_scoring: EnableScoring<<span class="lifetime">'_</span>>, |
| ) -> <span class="kw">crate</span>::Result<PhraseWeight> { |
| <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>.field); |
| <span class="kw">let </span>has_positions = field_entry |
| .field_type() |
| .get_index_record_option() |
| .map(IndexRecordOption::has_positions) |
| .unwrap_or(<span class="bool-val">false</span>); |
| <span class="kw">if </span>!has_positions { |
| <span class="kw">let </span>field_name = field_entry.name(); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="kw">crate</span>::TantivyError::SchemaError(<span class="macro">format!</span>( |
| <span class="string">"Applied phrase query on field {:?}, which does not have positions indexed"</span>, |
| field_name |
| ))); |
| } |
| <span class="kw">let </span>terms = <span class="self">self</span>.phrase_terms(); |
| <span class="kw">let </span>bm25_weight_opt = <span class="kw">match </span>enable_scoring { |
| EnableScoring::Enabled(searcher) => <span class="prelude-val">Some</span>(Bm25Weight::for_terms(searcher, <span class="kw-2">&</span>terms)<span class="question-mark">?</span>), |
| EnableScoring::Disabled(<span class="kw">_</span>) => <span class="prelude-val">None</span>, |
| }; |
| <span class="kw">let </span><span class="kw-2">mut </span>weight = PhraseWeight::new(<span class="self">self</span>.phrase_terms.clone(), bm25_weight_opt); |
| <span class="kw">if </span><span class="self">self</span>.slop > <span class="number">0 </span>{ |
| weight.slop(<span class="self">self</span>.slop); |
| } |
| <span class="prelude-val">Ok</span>(weight) |
| } |
| } |
| |
| <span class="kw">impl </span>Query <span class="kw">for </span>PhraseQuery { |
| <span class="doccomment">/// Create the weight associated with a query. |
| /// |
| /// 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="kw">let </span>phrase_weight = <span class="self">self</span>.phrase_weight(enable_scoring)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(Box::new(phrase_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="kw">for </span>(<span class="kw">_</span>, term) <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.phrase_terms { |
| visitor(term, <span class="bool-val">true</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> |
