rust/tantivy
1
0
Fork 0
mirror of https://github.com/quickwit-oss/tantivy.git synced 2026-05-24 12:10:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automatic Travis documentation build

Browse Source
This commit is contained in:
Travis CI User
2018-05-18 01:03:38 +00:00
parent 60d8bbc717
commit 2ef4686603
16 changed files with 148 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
master/aliases.js
View File

@@ -57,6 +57,7 @@ ALIASES['serde_json'] = {};
ALIASES['stable_deref_trait'] = {};
ALIASES['syn'] = {};
ALIASES['tantivy'] = {};
ALIASES['tantivy'] = {};
ALIASES['tempdir'] = {};
ALIASES['tempfile'] = {};
ALIASES['thread_local'] = {};

2
master/implementors/core/clone/trait.Clone.js
View File

File diff suppressed because one or more lines are too long

2
master/implementors/downcast/trait.Downcast.js
View File

@@ -1,6 +1,6 @@
(function() {var implementors = {};
implementors["downcast"] = [];
implementors["tantivy"] = [{text:"impl&lt;_T:&nbsp;<a class=\"trait\" href=\"downcast/trait.Any.html\" title=\"trait downcast::Any\">Any</a>&gt; <a class=\"trait\" href=\"downcast/trait.Downcast.html\" title=\"trait downcast::Downcast\">Downcast</a>&lt;_T&gt; for <a class=\"trait\" href=\"tantivy/query/trait.Scorer.html\" title=\"trait tantivy::query::Scorer\">Scorer</a> <span class=\"where fmt-newline\">where<br>&nbsp;&nbsp;&nbsp;&nbsp;_T: <a class=\"trait\" href=\"downcast/trait.Any.html\" title=\"trait downcast::Any\">Any</a>,&nbsp;</span>",synthetic:false,types:["tantivy::query::scorer::Scorer"]},];
implementors["tantivy"] = [{text:"impl&lt;_T:&nbsp;<a class=\"trait\" href=\"downcast/trait.Any.html\" title=\"trait downcast::Any\">Any</a>&gt; <a class=\"trait\" href=\"downcast/trait.Downcast.html\" title=\"trait downcast::Downcast\">Downcast</a>&lt;_T&gt; for <a class=\"trait\" href=\"tantivy/query/trait.Query.html\" title=\"trait tantivy::query::Query\">Query</a> <span class=\"where fmt-newline\">where<br>&nbsp;&nbsp;&nbsp;&nbsp;_T: <a class=\"trait\" href=\"downcast/trait.Any.html\" title=\"trait downcast::Any\">Any</a>,&nbsp;</span>",synthetic:false,types:["tantivy::query::query::Query"]},{text:"impl&lt;_T:&nbsp;<a class=\"trait\" href=\"downcast/trait.Any.html\" title=\"trait downcast::Any\">Any</a>&gt; <a class=\"trait\" href=\"downcast/trait.Downcast.html\" title=\"trait downcast::Downcast\">Downcast</a>&lt;_T&gt; for <a class=\"trait\" href=\"tantivy/query/trait.Scorer.html\" title=\"trait tantivy::query::Scorer\">Scorer</a> <span class=\"where fmt-newline\">where<br>&nbsp;&nbsp;&nbsp;&nbsp;_T: <a class=\"trait\" href=\"downcast/trait.Any.html\" title=\"trait downcast::Any\">Any</a>,&nbsp;</span>",synthetic:false,types:["tantivy::query::scorer::Scorer"]},];
if (window.register_implementors) {
window.register_implementors(implementors);

2
master/search-index.js
View File

File diff suppressed because one or more lines are too long

2
master/src/tantivy/query/all_query.rs.html
View File

@@ -135,7 +135,7 @@
<span class="doccomment">/// Query that matches all of the documents.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// All of the document get the score 1f32.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AllQuery</span>;
<span class="kw">impl</span> <span class="ident">Query</span> <span class="kw">for</span> <span class="ident">AllQuery</span> {

28
master/src/tantivy/query/boolean_query/boolean_query.rs.html
View File

@@ -56,6 +56,20 @@
<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>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">boolean_weight</span>::<span class="ident">BooleanWeight</span>;
<span class="kw">use</span> <span class="ident">query</span>::<span class="ident">Occur</span>;
@@ -82,6 +96,16 @@
<span class="ident">subqueries</span>: <span class="ident">Vec</span><span class="op">&lt;</span>(<span class="ident">Occur</span>, <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">Query</span><span class="op">&gt;</span>)<span class="op">&gt;</span>,
}
<span class="kw">impl</span> <span class="ident">Clone</span> <span class="kw">for</span> <span class="ident">BooleanQuery</span> {
<span class="kw">fn</span> <span class="ident">clone</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">subqueries</span>
.<span class="ident">iter</span>()
.<span class="ident">map</span>(<span class="op">|</span>(<span class="ident">x</span>, <span class="ident">y</span>)<span class="op">|</span> (<span class="ident">x</span>.<span class="ident">clone</span>(), <span class="ident">y</span>.<span class="ident">box_clone</span>()))
.<span class="ident">collect</span>::<span class="op">&lt;</span><span class="ident">Vec</span><span class="op">&lt;</span><span class="kw">_</span><span class="op">&gt;&gt;</span>()
.<span class="ident">into</span>()
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op">&lt;</span><span class="ident">Vec</span><span class="op">&lt;</span>(<span class="ident">Occur</span>, <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">Query</span><span class="op">&gt;</span>)<span class="op">&gt;&gt;</span> <span class="kw">for</span> <span class="ident">BooleanQuery</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">subqueries</span>: <span class="ident">Vec</span><span class="op">&lt;</span>(<span class="ident">Occur</span>, <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">Query</span><span class="op">&gt;</span>)<span class="op">&gt;</span>) <span class="op">-&gt;</span> <span class="ident">BooleanQuery</span> {
<span class="ident">BooleanQuery</span> { <span class="ident">subqueries</span> }
@@ -114,6 +138,10 @@
.<span class="ident">collect</span>();
<span class="ident">BooleanQuery</span>::<span class="ident">from</span>(<span class="ident">occur_term_queries</span>)
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clauses</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span>[(<span class="ident">Occur</span>, <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">Query</span><span class="op">&gt;</span>)] {
<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">subqueries</span>[..]
}
}
</pre>
</section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../../";window.currentCrate = "tantivy";</script><script src="../../../../aliases.js"></script><script src="../../../../main.js"></script><script defer src="../../../../search-index.js"></script></body></html>

18
master/src/tantivy/query/phrase_query/phrase_query.rs.html
View File

@@ -81,6 +81,14 @@
<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>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">PhraseWeight</span>;
<span class="kw">use</span> <span class="ident">core</span>::<span class="ident">searcher</span>::<span class="ident">Searcher</span>;
@@ -105,7 +113,7 @@
<span class="doccomment">/// Using a `PhraseQuery` on a field requires positions</span>
<span class="doccomment">/// to be indexed for this field.</span>
<span class="doccomment">///</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">PhraseQuery</span> {
<span class="ident">field</span>: <span class="ident">Field</span>,
<span class="ident">phrase_terms</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">Term</span><span class="op">&gt;</span>,
@@ -131,6 +139,14 @@
<span class="ident">phrase_terms</span>: <span class="ident">terms</span>,
}
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">field</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Field</span> {
<span class="self">self</span>.<span class="ident">field</span>
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">phrase_terms</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span>[<span class="ident">Term</span>] {
<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">phrase_terms</span>[..]
}
}
<span class="kw">impl</span> <span class="ident">Query</span> <span class="kw">for</span> <span class="ident">PhraseQuery</span> {

39
master/src/tantivy/query/query.rs.html
View File

@@ -77,10 +77,29 @@
<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>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">Weight</span>;
<span class="kw">use</span> <span class="ident">collector</span>::<span class="ident">Collector</span>;
<span class="kw">use</span> <span class="ident">core</span>::<span class="ident">searcher</span>::<span class="ident">Searcher</span>;
<span class="kw">use</span> <span class="ident">downcast</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;
<span class="kw">use</span> <span class="prelude-ty">Result</span>;
<span class="kw">use</span> <span class="ident">SegmentLocalId</span>;
@@ -118,7 +137,7 @@
<span class="doccomment">///</span>
<span class="doccomment">/// When implementing a new type of `Query`, it is normal to implement a</span>
<span class="doccomment">/// dedicated `Query`, `Weight` and `Scorer`.</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Query</span>: <span class="ident">fmt</span>::<span class="ident">Debug</span> {
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Query</span>: <span class="ident">QueryClone</span> <span class="op">+</span> <span class="ident">downcast</span>::<span class="ident">Any</span> <span class="op">+</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> {
<span class="doccomment">/// Create the weight associated to a query.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If scoring is not required, setting `scoring_enabled` to `false`</span>
@@ -157,5 +176,21 @@
<span class="prelude-val">Ok</span>(())
}
}
</pre>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">QueryClone</span> {
<span class="kw">fn</span> <span class="ident">box_clone</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">Query</span><span class="op">&gt;</span>;
}
<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> <span class="ident">QueryClone</span> <span class="kw">for</span> <span class="ident">T</span>
<span class="kw">where</span> <span class="ident">T</span>: <span class="lifetime">&#39;static</span> <span class="op">+</span> <span class="ident">Query</span> <span class="op">+</span> <span class="ident">Clone</span>
{
<span class="kw">fn</span> <span class="ident">box_clone</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">Query</span><span class="op">&gt;</span> {
<span class="ident">Box</span>::<span class="ident">new</span>(<span class="self">self</span>.<span class="ident">clone</span>())
}
}
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">missing_docs</span>)]</span>
<span class="kw">mod</span> <span class="ident">downcast_impl</span> {
<span class="macro">downcast</span><span class="macro">!</span>(<span class="kw">super</span>::<span class="ident">Query</span>);
}</pre>
</section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "tantivy";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>

2
master/src/tantivy/query/range_query.rs.html
View File

@@ -445,7 +445,7 @@
<span class="doccomment">/// # run().unwrap()</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">RangeQuery</span> {
<span class="ident">field</span>: <span class="ident">Field</span>,
<span class="ident">value_type</span>: <span class="ident">Type</span>,

10
master/src/tantivy/query/term_query/term_query.rs.html
View File

@@ -53,6 +53,10 @@
<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>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">term_weight</span>::<span class="ident">TermWeight</span>;
<span class="kw">use</span> <span class="ident">query</span>::<span class="ident">bm25</span>::<span class="ident">BM25Weight</span>;
@@ -72,7 +76,7 @@
<span class="doccomment">/// * `idf` - inverse document frequency.</span>
<span class="doccomment">/// * `term_freq` - number of occurrences of the term in the field</span>
<span class="doccomment">/// * `field norm` - number of tokens in the field.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">TermQuery</span> {
<span class="ident">term</span>: <span class="ident">Term</span>,
<span class="ident">index_record_option</span>: <span class="ident">IndexRecordOption</span>,
@@ -87,6 +91,10 @@
}
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">term</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">Term</span> {
<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">term</span>
}
<span class="doccomment">/// Returns a weight object.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// While `.weight(...)` returns a boxed trait object,</span>

10
master/tantivy/query/struct.AllQuery.html
View File

@@ -1,13 +1,15 @@
<!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="API documentation for the Rust `AllQuery` struct in crate `tantivy`."><meta name="keywords" content="rust, rustlang, rust-lang, AllQuery"><title>tantivy::query::AllQuery - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../tantivy/index.html'><img src='http://fulmicoton.com/tantivy-logo/tantivy-logo.png' alt='logo' width='100'></a><p class='location'>Struct AllQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Query">Query</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'AllQuery', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>AllQuery</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/tantivy/query/all_query.rs.html#13' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct AllQuery;</pre></div><div class='docblock'><p>Query that matches all of the documents.</p>
<!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="API documentation for the Rust `AllQuery` struct in crate `tantivy`."><meta name="keywords" content="rust, rustlang, rust-lang, AllQuery"><title>tantivy::query::AllQuery - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../tantivy/index.html'><img src='http://fulmicoton.com/tantivy-logo/tantivy-logo.png' alt='logo' width='100'></a><p class='location'>Struct AllQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Query">Query</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'AllQuery', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>AllQuery</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/tantivy/query/all_query.rs.html#13' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct AllQuery;</pre></div><div class='docblock'><p>Query that matches all of the documents.</p>
<p>All of the document get the score 1f32.</p>
</div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tantivy/query/struct.AllQuery.html" title="struct tantivy::query::AllQuery">AllQuery</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/all_query.rs.html#12' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/all_query.rs.html#12' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
<div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../tantivy/query/struct.AllQuery.html" title="struct tantivy::query::AllQuery">AllQuery</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/all_query.rs.html#12' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../tantivy/query/struct.AllQuery.html" title="struct tantivy::query::AllQuery">AllQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/all_query.rs.html#12' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tantivy/query/struct.AllQuery.html" title="struct tantivy::query::AllQuery">AllQuery</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/all_query.rs.html#12' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/all_query.rs.html#12' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Query' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a> for <a class="struct" href="../../tantivy/query/struct.AllQuery.html" title="struct tantivy::query::AllQuery">AllQuery</a></code><a href='#impl-Query' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/all_query.rs.html#15-19' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.weight' class="method"><span id='weight.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#tymethod.weight' class='fnname'>weight</a>(&amp;self, _: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Weight.html" title="trait tantivy::query::Weight">Weight</a>&gt;&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/all_query.rs.html#16-18' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create the weight associated to a query. <a href="../../tantivy/query/trait.Query.html#tymethod.weight">Read more</a></p>
</div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.count' class='fnname'>count</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#51-58' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the number of documents matching the query.</p>
</div><h4 id='method.search' class="method"><span id='search.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.search' class='fnname'>search</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, collector: &amp;mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#69-78' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Search works as follows : <a href="../../tantivy/query/trait.Query.html#method.search">Read more</a></p>
</div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.count' class='fnname'>count</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#52-59' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the number of documents matching the query.</p>
</div><h4 id='method.search' class="method"><span id='search.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.search' class='fnname'>search</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, collector: &amp;mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#70-79' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Search works as follows : <a href="../../tantivy/query/trait.Query.html#method.search">Read more</a></p>
</div></div></div>
<h2 id='synthetic-implementations' class='small-section-header'>
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>

16
master/tantivy/query/struct.BooleanQuery.html
View File

@@ -1,4 +1,4 @@
<!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="API documentation for the Rust `BooleanQuery` struct in crate `tantivy`."><meta name="keywords" content="rust, rustlang, rust-lang, BooleanQuery"><title>tantivy::query::BooleanQuery - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../tantivy/index.html'><img src='http://fulmicoton.com/tantivy-logo/tantivy-logo.png' alt='logo' width='100'></a><p class='location'>Struct BooleanQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new_multiterms_query">new_multiterms_query</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-From%3CVec%3C(Occur%2C%20Box%3CQuery%3E)%3E%3E">From&lt;Vec&lt;(Occur, Box&lt;Query&gt;)&gt;&gt;</a><a href="#impl-Query">Query</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'BooleanQuery', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>BooleanQuery</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#22-24' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct BooleanQuery { /* fields omitted */ }</pre></div><div class='docblock'><p>The boolean query combines a set of queries</p>
<!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="API documentation for the Rust `BooleanQuery` struct in crate `tantivy`."><meta name="keywords" content="rust, rustlang, rust-lang, BooleanQuery"><title>tantivy::query::BooleanQuery - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../tantivy/index.html'><img src='http://fulmicoton.com/tantivy-logo/tantivy-logo.png' alt='logo' width='100'></a><p class='location'>Struct BooleanQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new_multiterms_query">new_multiterms_query</a><a href="#method.clauses">clauses</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Clone">Clone</a><a href="#impl-From%3CVec%3C(Occur%2C%20Box%3CQuery%3E)%3E%3E">From&lt;Vec&lt;(Occur, Box&lt;Query&gt;)&gt;&gt;</a><a href="#impl-Query">Query</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'BooleanQuery', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>BooleanQuery</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#22-24' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct BooleanQuery { /* fields omitted */ }</pre></div><div class='docblock'><p>The boolean query combines a set of queries</p>
<p>The documents matched by the boolean query are
those which</p>
<ul>
@@ -13,17 +13,19 @@ a <code>MustNot</code> occurence.</li>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#44-58' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new_multiterms_query' class="method"><span id='new_multiterms_query.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new_multiterms_query' class='fnname'>new_multiterms_query</a>(terms: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../tantivy/struct.Term.html" title="struct tantivy::Term">Term</a>&gt;) -&gt; <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#47-57' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Helper method to create a boolean query matching a given list of terms.
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#54-72' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new_multiterms_query' class="method"><span id='new_multiterms_query.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new_multiterms_query' class='fnname'>new_multiterms_query</a>(terms: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../tantivy/struct.Term.html" title="struct tantivy::Term">Term</a>&gt;) -&gt; <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#57-67' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Helper method to create a boolean query matching a given list of terms.
The resulting query is a disjunction of the terms.</p>
</div></div>
</div><h4 id='method.clauses' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></h3><code class="content"><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></code></div></div><span id='clauses.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.clauses' class='fnname'>clauses</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="../../tantivy/query/enum.Occur.html" title="enum tantivy::query::Occur">Occur</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a>&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#69-71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#21' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#21' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-From%3CVec%3C(Occur%2C%20Box%3CQuery%3E)%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="../../tantivy/query/enum.Occur.html" title="enum tantivy::query::Occur">Occur</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a>&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;&gt; for <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code><a href='#impl-From%3CVec%3C(Occur%2C%20Box%3CQuery%3E)%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#26-30' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(subqueries: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="../../tantivy/query/enum.Occur.html" title="enum tantivy::query::Occur">Occur</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a>&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;) -&gt; <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#27-29' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Query' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a> for <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code><a href='#impl-Query' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#32-42' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.weight' class="method"><span id='weight.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#tymethod.weight' class='fnname'>weight</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;scoring_enabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Weight.html" title="trait tantivy::query::Weight">Weight</a>&gt;&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#33-41' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create the weight associated to a query. <a href="../../tantivy/query/trait.Query.html#tymethod.weight">Read more</a></p>
</div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.count' class='fnname'>count</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#51-58' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the number of documents matching the query.</p>
</div><h4 id='method.search' class="method"><span id='search.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.search' class='fnname'>search</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, collector: &amp;mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#69-78' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Search works as follows : <a href="../../tantivy/query/trait.Query.html#method.search">Read more</a></p>
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#26-34' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#27-33' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-From%3CVec%3C(Occur%2C%20Box%3CQuery%3E)%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="../../tantivy/query/enum.Occur.html" title="enum tantivy::query::Occur">Occur</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a>&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;&gt; for <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code><a href='#impl-From%3CVec%3C(Occur%2C%20Box%3CQuery%3E)%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#36-40' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(subqueries: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="../../tantivy/query/enum.Occur.html" title="enum tantivy::query::Occur">Occur</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a>&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;) -&gt; <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#37-39' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Query' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a> for <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code><a href='#impl-Query' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#42-52' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.weight' class="method"><span id='weight.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#tymethod.weight' class='fnname'>weight</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;scoring_enabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Weight.html" title="trait tantivy::query::Weight">Weight</a>&gt;&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#43-51' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create the weight associated to a query. <a href="../../tantivy/query/trait.Query.html#tymethod.weight">Read more</a></p>
</div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.count' class='fnname'>count</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#52-59' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the number of documents matching the query.</p>
</div><h4 id='method.search' class="method"><span id='search.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.search' class='fnname'>search</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, collector: &amp;mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#70-79' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Search works as follows : <a href="../../tantivy/query/trait.Query.html#method.search">Read more</a></p>
</div></div></div>
<h2 id='synthetic-implementations' class='small-section-header'>
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>

16
master/tantivy/query/struct.PhraseQuery.html
View File

@@ -1,4 +1,4 @@
<!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="API documentation for the Rust `PhraseQuery` struct in crate `tantivy`."><meta name="keywords" content="rust, rustlang, rust-lang, PhraseQuery"><title>tantivy::query::PhraseQuery - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../tantivy/index.html'><img src='http://fulmicoton.com/tantivy-logo/tantivy-logo.png' alt='logo' width='100'></a><p class='location'>Struct PhraseQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Query">Query</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'PhraseQuery', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>PhraseQuery</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#25-28' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct PhraseQuery { /* fields omitted */ }</pre></div><div class='docblock'><p><code>PhraseQuery</code> matches a specific sequence of words.</p>
<!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="API documentation for the Rust `PhraseQuery` struct in crate `tantivy`."><meta name="keywords" content="rust, rustlang, rust-lang, PhraseQuery"><title>tantivy::query::PhraseQuery - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../tantivy/index.html'><img src='http://fulmicoton.com/tantivy-logo/tantivy-logo.png' alt='logo' width='100'></a><p class='location'>Struct PhraseQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.field">field</a><a href="#method.phrase_terms">phrase_terms</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Query">Query</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'PhraseQuery', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>PhraseQuery</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#25-28' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct PhraseQuery { /* fields omitted */ }</pre></div><div class='docblock'><p><code>PhraseQuery</code> matches a specific sequence of words.</p>
<p>For instance the phrase query for <code>&quot;part time&quot;</code> will match
the sentence</p>
<p><strong>Alan just got a part time job.</strong></p>
@@ -10,18 +10,20 @@ to be indexed for this field.</p>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../tantivy/query/struct.PhraseQuery.html" title="struct tantivy::query::PhraseQuery">PhraseQuery</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#30-50' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(terms: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../tantivy/struct.Term.html" title="struct tantivy::Term">Term</a>&gt;) -&gt; <a class="struct" href="../../tantivy/query/struct.PhraseQuery.html" title="struct tantivy::query::PhraseQuery">PhraseQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#35-49' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new <code>PhraseQuery</code> given a list of terms.</p>
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../tantivy/query/struct.PhraseQuery.html" title="struct tantivy::query::PhraseQuery">PhraseQuery</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#30-58' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(terms: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../tantivy/struct.Term.html" title="struct tantivy::Term">Term</a>&gt;) -&gt; <a class="struct" href="../../tantivy/query/struct.PhraseQuery.html" title="struct tantivy::query::PhraseQuery">PhraseQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#35-49' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new <code>PhraseQuery</code> given a list of terms.</p>
<p>There must be at least two terms, and all terms
must belong to the same field.</p>
</div></div>
</div><h4 id='method.field' class="method"><span id='field.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.field' class='fnname'>field</a>(&amp;self) -&gt; <a class="struct" href="../../tantivy/schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#51-53' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.phrase_terms' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></h3><code class="content"><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></code></div></div><span id='phrase_terms.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.phrase_terms' class='fnname'>phrase_terms</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="struct" href="../../tantivy/struct.Term.html" title="struct tantivy::Term">Term</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#55-57' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tantivy/query/struct.PhraseQuery.html" title="struct tantivy::query::PhraseQuery">PhraseQuery</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#24' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#24' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Query' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a> for <a class="struct" href="../../tantivy/query/struct.PhraseQuery.html" title="struct tantivy::query::PhraseQuery">PhraseQuery</a></code><a href='#impl-Query' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#52-83' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.weight' class="method"><span id='weight.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#tymethod.weight' class='fnname'>weight</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;scoring_enabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Weight.html" title="trait tantivy::query::Weight">Weight</a>&gt;&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#56-82' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create the weight associated to a query.</p>
<div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../tantivy/query/struct.PhraseQuery.html" title="struct tantivy::query::PhraseQuery">PhraseQuery</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#24' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../tantivy/query/struct.PhraseQuery.html" title="struct tantivy::query::PhraseQuery">PhraseQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#24' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tantivy/query/struct.PhraseQuery.html" title="struct tantivy::query::PhraseQuery">PhraseQuery</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#24' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#24' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Query' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a> for <a class="struct" href="../../tantivy/query/struct.PhraseQuery.html" title="struct tantivy::query::PhraseQuery">PhraseQuery</a></code><a href='#impl-Query' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#60-91' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.weight' class="method"><span id='weight.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#tymethod.weight' class='fnname'>weight</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;scoring_enabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Weight.html" title="trait tantivy::query::Weight">Weight</a>&gt;&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/phrase_query/phrase_query.rs.html#64-90' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create the weight associated to a query.</p>
<p>See <a href="./trait.Weight.html"><code>Weight</code></a>.</p>
</div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.count' class='fnname'>count</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#51-58' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the number of documents matching the query.</p>
</div><h4 id='method.search' class="method"><span id='search.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.search' class='fnname'>search</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, collector: &amp;mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#69-78' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Search works as follows : <a href="../../tantivy/query/trait.Query.html#method.search">Read more</a></p>
</div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.count' class='fnname'>count</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#52-59' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the number of documents matching the query.</p>
</div><h4 id='method.search' class="method"><span id='search.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.search' class='fnname'>search</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, collector: &amp;mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#70-79' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Search works as follows : <a href="../../tantivy/query/trait.Query.html#method.search">Read more</a></p>
</div></div></div>
<h2 id='synthetic-implementations' class='small-section-header'>
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>

10
master/tantivy/query/struct.RangeQuery.html
View File

@@ -1,4 +1,4 @@
<!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="API documentation for the Rust `RangeQuery` struct in crate `tantivy`."><meta name="keywords" content="rust, rustlang, rust-lang, RangeQuery"><title>tantivy::query::RangeQuery - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../tantivy/index.html'><img src='http://fulmicoton.com/tantivy-logo/tantivy-logo.png' alt='logo' width='100'></a><p class='location'>Struct RangeQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new_i64">new_i64</a><a href="#method.new_i64_bounds">new_i64_bounds</a><a href="#method.new_u64_bounds">new_u64_bounds</a><a href="#method.new_u64">new_u64</a><a href="#method.new_str_bounds">new_str_bounds</a><a href="#method.new_str">new_str</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Query">Query</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'RangeQuery', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>RangeQuery</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/tantivy/query/range_query.rs.html#84-89' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct RangeQuery { /* fields omitted */ }</pre></div><div class='docblock'><p><code>RangeQuery</code> match all documents that have at least one term within a defined range.</p>
<!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="API documentation for the Rust `RangeQuery` struct in crate `tantivy`."><meta name="keywords" content="rust, rustlang, rust-lang, RangeQuery"><title>tantivy::query::RangeQuery - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../tantivy/index.html'><img src='http://fulmicoton.com/tantivy-logo/tantivy-logo.png' alt='logo' width='100'></a><p class='location'>Struct RangeQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new_i64">new_i64</a><a href="#method.new_i64_bounds">new_i64_bounds</a><a href="#method.new_u64_bounds">new_u64_bounds</a><a href="#method.new_u64">new_u64</a><a href="#method.new_str_bounds">new_str_bounds</a><a href="#method.new_str">new_str</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Query">Query</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'RangeQuery', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>RangeQuery</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/tantivy/query/range_query.rs.html#84-89' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct RangeQuery { /* fields omitted */ }</pre></div><div class='docblock'><p><code>RangeQuery</code> match all documents that have at least one term within a defined range.</p>
<p>Matched document will all get a constant <code>Score</code> of one.</p>
<h1 id="implementation" class="section-header"><a href="#implementation">Implementation</a></h1>
<p>The current implement will iterate over the terms within the range
@@ -47,10 +47,12 @@ will panic when the <code>Weight</code> object is created.</p>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tantivy/query/struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/range_query.rs.html#83' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/range_query.rs.html#83' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
<div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../tantivy/query/struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/range_query.rs.html#83' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../tantivy/query/struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/range_query.rs.html#83' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tantivy/query/struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/range_query.rs.html#83' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/range_query.rs.html#83' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Query' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a> for <a class="struct" href="../../tantivy/query/struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></code><a href='#impl-Query' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/range_query.rs.html#192-209' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.weight' class="method"><span id='weight.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#tymethod.weight' class='fnname'>weight</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;_scoring_enabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Weight.html" title="trait tantivy::query::Weight">Weight</a>&gt;&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/range_query.rs.html#193-208' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create the weight associated to a query. <a href="../../tantivy/query/trait.Query.html#tymethod.weight">Read more</a></p>
</div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.count' class='fnname'>count</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#51-58' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the number of documents matching the query.</p>
</div><h4 id='method.search' class="method"><span id='search.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.search' class='fnname'>search</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, collector: &amp;mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#69-78' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Search works as follows : <a href="../../tantivy/query/trait.Query.html#method.search">Read more</a></p>
</div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.count' class='fnname'>count</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#52-59' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the number of documents matching the query.</p>
</div><h4 id='method.search' class="method"><span id='search.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.search' class='fnname'>search</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, collector: &amp;mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#70-79' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Search works as follows : <a href="../../tantivy/query/trait.Query.html#method.search">Read more</a></p>
</div></div></div>
<h2 id='synthetic-implementations' class='small-section-header'>
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>

16
master/tantivy/query/struct.TermQuery.html
View File

@@ -1,4 +1,4 @@
<!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="API documentation for the Rust `TermQuery` struct in crate `tantivy`."><meta name="keywords" content="rust, rustlang, rust-lang, TermQuery"><title>tantivy::query::TermQuery - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../tantivy/index.html'><img src='http://fulmicoton.com/tantivy-logo/tantivy-logo.png' alt='logo' width='100'></a><p class='location'>Struct TermQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.specialized_weight">specialized_weight</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Query">Query</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'TermQuery', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>TermQuery</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#20-23' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct TermQuery { /* fields omitted */ }</pre></div><div class='docblock'><p>A Term query matches all of the documents
<!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="API documentation for the Rust `TermQuery` struct in crate `tantivy`."><meta name="keywords" content="rust, rustlang, rust-lang, TermQuery"><title>tantivy::query::TermQuery - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../tantivy/index.html'><img src='http://fulmicoton.com/tantivy-logo/tantivy-logo.png' alt='logo' width='100'></a><p class='location'>Struct TermQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.term">term</a><a href="#method.specialized_weight">specialized_weight</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Query">Query</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'TermQuery', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>TermQuery</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#20-23' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct TermQuery { /* fields omitted */ }</pre></div><div class='docblock'><p>A Term query matches all of the documents
containing a specific term.</p>
<p>The score associated is defined as
<code>idf</code> * sqrt(<code>term_freq</code> / <code>field norm</code>)
@@ -12,8 +12,8 @@ in which :</p>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../tantivy/query/struct.TermQuery.html" title="struct tantivy::query::TermQuery">TermQuery</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#25-49' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(term: <a class="struct" href="../../tantivy/struct.Term.html" title="struct tantivy::Term">Term</a>, segment_postings_options: <a class="enum" href="../../tantivy/schema/enum.IndexRecordOption.html" title="enum tantivy::schema::IndexRecordOption">IndexRecordOption</a>) -&gt; <a class="struct" href="../../tantivy/query/struct.TermQuery.html" title="struct tantivy::query::TermQuery">TermQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#27-32' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new term query.</p>
</div><h4 id='method.specialized_weight' class="method"><span id='specialized_weight.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.specialized_weight' class='fnname'>specialized_weight</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;scoring_enabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -&gt; TermWeight</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#39-48' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a weight object.</p>
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../tantivy/query/struct.TermQuery.html" title="struct tantivy::query::TermQuery">TermQuery</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#25-53' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(term: <a class="struct" href="../../tantivy/struct.Term.html" title="struct tantivy::Term">Term</a>, segment_postings_options: <a class="enum" href="../../tantivy/schema/enum.IndexRecordOption.html" title="enum tantivy::schema::IndexRecordOption">IndexRecordOption</a>) -&gt; <a class="struct" href="../../tantivy/query/struct.TermQuery.html" title="struct tantivy::query::TermQuery">TermQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#27-32' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new term query.</p>
</div><h4 id='method.term' class="method"><span id='term.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.term' class='fnname'>term</a>(&amp;self) -&gt; &amp;<a class="struct" href="../../tantivy/struct.Term.html" title="struct tantivy::Term">Term</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#34-36' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.specialized_weight' class="method"><span id='specialized_weight.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.specialized_weight' class='fnname'>specialized_weight</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;scoring_enabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -&gt; TermWeight</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#43-52' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a weight object.</p>
<p>While <code>.weight(...)</code> returns a boxed trait object,
this method return a specific implementation.
This is useful for optimization purpose.</p>
@@ -21,10 +21,12 @@ This is useful for optimization purpose.</p>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tantivy/query/struct.TermQuery.html" title="struct tantivy::query::TermQuery">TermQuery</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#19' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#19' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Query' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a> for <a class="struct" href="../../tantivy/query/struct.TermQuery.html" title="struct tantivy::query::TermQuery">TermQuery</a></code><a href='#impl-Query' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#51-55' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.weight' class="method"><span id='weight.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#tymethod.weight' class='fnname'>weight</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;scoring_enabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Weight.html" title="trait tantivy::query::Weight">Weight</a>&gt;&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#52-54' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create the weight associated to a query. <a href="../../tantivy/query/trait.Query.html#tymethod.weight">Read more</a></p>
</div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.count' class='fnname'>count</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#51-58' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the number of documents matching the query.</p>
</div><h4 id='method.search' class="method"><span id='search.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.search' class='fnname'>search</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, collector: &amp;mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#69-78' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Search works as follows : <a href="../../tantivy/query/trait.Query.html#method.search">Read more</a></p>
<div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../tantivy/query/struct.TermQuery.html" title="struct tantivy::query::TermQuery">TermQuery</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#19' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../tantivy/query/struct.TermQuery.html" title="struct tantivy::query::TermQuery">TermQuery</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#19' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tantivy/query/struct.TermQuery.html" title="struct tantivy::query::TermQuery">TermQuery</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#19' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#19' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Query' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a> for <a class="struct" href="../../tantivy/query/struct.TermQuery.html" title="struct tantivy::query::TermQuery">TermQuery</a></code><a href='#impl-Query' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#55-59' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.weight' class="method"><span id='weight.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#tymethod.weight' class='fnname'>weight</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;scoring_enabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../../tantivy/query/trait.Weight.html" title="trait tantivy::query::Weight">Weight</a>&gt;&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/term_query/term_query.rs.html#56-58' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create the weight associated to a query. <a href="../../tantivy/query/trait.Query.html#tymethod.weight">Read more</a></p>
</div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.count' class='fnname'>count</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#52-59' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the number of documents matching the query.</p>
</div><h4 id='method.search' class="method"><span id='search.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../tantivy/query/trait.Query.html#method.search' class='fnname'>search</a>(&amp;self, searcher: &amp;<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, collector: &amp;mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>) -&gt; <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#70-79' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Search works as follows : <a href="../../tantivy/query/trait.Query.html#method.search">Read more</a></p>
</div></div></div>
<h2 id='synthetic-implementations' class='small-section-header'>
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>

16
master/tantivy/query/trait.Query.html
View File

File diff suppressed because one or more lines are too long