| <!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="`RangeQuery` matches all documents that have at least one term within a defined range."><meta name="keywords" content="rust, rustlang, rust-lang, RangeQuery"><title>RangeQuery in tantivy::query - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../tantivy/index.html"><div class="logo-container"><img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tantivy/index.html"><div class="logo-container"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a><h2 class="location"><a href="#">RangeQuery</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.field">field</a></li><li><a href="#method.left_bound">left_bound</a></li><li><a href="#method.new_f64">new_f64</a></li><li><a href="#method.new_f64_bounds">new_f64_bounds</a></li><li><a href="#method.new_i64">new_i64</a></li><li><a href="#method.new_i64_bounds">new_i64_bounds</a></li><li><a href="#method.new_str">new_str</a></li><li><a href="#method.new_str_bounds">new_str_bounds</a></li><li><a href="#method.new_term_bounds">new_term_bounds</a></li><li><a href="#method.new_u64">new_u64</a></li><li><a href="#method.new_u64_bounds">new_u64_bounds</a></li><li><a href="#method.right_bound">right_bound</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-RangeQuery">Clone</a></li><li><a href="#impl-Debug-for-RangeQuery">Debug</a></li><li><a href="#impl-Query-for-RangeQuery">Query</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-RangeQuery">RefUnwindSafe</a></li><li><a href="#impl-Send-for-RangeQuery">Send</a></li><li><a href="#impl-Sync-for-RangeQuery">Sync</a></li><li><a href="#impl-Unpin-for-RangeQuery">Unpin</a></li><li><a href="#impl-UnwindSafe-for-RangeQuery">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-RangeQuery">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-RangeQuery">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-RangeQuery">BorrowMut<T></a></li><li><a href="#impl-Downcast-for-RangeQuery">Downcast</a></li><li><a href="#impl-DowncastSync-for-RangeQuery">DowncastSync</a></li><li><a href="#impl-From%3CT%3E-for-RangeQuery">From<T></a></li><li><a href="#impl-Fruit-for-RangeQuery">Fruit</a></li><li><a href="#impl-Into%3CU%3E-for-RangeQuery">Into<U></a></li><li><a href="#impl-Pointable-for-RangeQuery">Pointable</a></li><li><a href="#impl-ToOwned-for-RangeQuery">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-RangeQuery">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-RangeQuery">TryInto<U></a></li><li><a href="#impl-VZip%3CV%3E-for-RangeQuery">VZip<V></a></li></ul></section><h2><a href="index.html">In tantivy::query</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">tantivy</a>::<wbr><a href="index.html">query</a>::<wbr><a class="struct" href="#">RangeQuery</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tantivy/query/range_query.rs.html#77-82">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct RangeQuery { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>RangeQuery</code> matches 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> |
| <h2 id="implementation"><a href="#implementation">Implementation</a></h2><h3 id="default"><a href="#default">Default</a></h3> |
| <p>The default implementation collects all documents <em>upfront</em> into a <code>BitSet</code>. |
| This is done by iterating over the terms within the range and loading all docs for each |
| <code>TermInfo</code> from the inverted index (posting list) and put them into a <code>BitSet</code>. |
| Depending on the number of terms matched, this is a potentially expensive operation.</p> |
| <h3 id="ip-fast-field"><a href="#ip-fast-field">IP fast field</a></h3> |
| <p>For IP fast fields a custom variant is used, by scanning the fast field. Unlike the default |
| variant we can walk in a lazy fashion over it, since the fastfield is implicit orderered by |
| DocId.</p> |
| <h2 id="example"><a href="#example">Example</a></h2> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tantivy::collector::Count; |
| <span class="kw">use </span>tantivy::query::RangeQuery; |
| <span class="kw">use </span>tantivy::schema::{Schema, INDEXED}; |
| <span class="kw">use </span>tantivy::{doc, Index}; |
| <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder(); |
| <span class="kw">let </span>year_field = schema_builder.add_u64_field(<span class="string">"year"</span>, INDEXED); |
| <span class="kw">let </span>schema = schema_builder.build(); |
| |
| <span class="kw">let </span>index = Index::create_in_ram(schema); |
| <span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_with_num_threads(<span class="number">1</span>, <span class="number">10_000_000</span>)<span class="question-mark">?</span>; |
| <span class="kw">for </span>year <span class="kw">in </span><span class="number">1950u64</span>..<span class="number">2017u64 </span>{ |
| <span class="kw">let </span>num_docs_within_year = <span class="number">10 </span>+ (year - <span class="number">1950</span>) * (year - <span class="number">1950</span>); |
| <span class="kw">for _ in </span><span class="number">0</span>..num_docs_within_year { |
| index_writer.add_document(<span class="macro">doc!</span>(year_field => year))<span class="question-mark">?</span>; |
| } |
| } |
| index_writer.commit()<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>reader = index.reader()<span class="question-mark">?</span>; |
| <span class="kw">let </span>searcher = reader.searcher(); |
| <span class="kw">let </span>docs_in_the_sixties = RangeQuery::new_u64(year_field, <span class="number">1960</span>..<span class="number">1970</span>); |
| <span class="kw">let </span>num_60s_books = searcher.search(<span class="kw-2">&</span>docs_in_the_sixties, <span class="kw-2">&</span>Count)<span class="question-mark">?</span>; |
| <span class="macro">assert_eq!</span>(num_60s_books, <span class="number">2285</span>); |
| <span class="prelude-val">Ok</span>(())</code></pre></div> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-RangeQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#84-253">source</a><a href="#impl-RangeQuery" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_term_bounds" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#89-105">source</a><h4 class="code-header">pub fn <a href="#method.new_term_bounds" class="fnname">new_term_bounds</a>(<br> field: <a class="struct" href="../schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>,<br> value_type: <a class="enum" href="../schema/enum.Type.html" title="enum tantivy::schema::Type">Type</a>,<br> left_bound: &Bound<<a class="struct" href="../schema/struct.Term.html" title="struct tantivy::schema::Term">Term</a>>,<br> right_bound: &Bound<<a class="struct" href="../schema/struct.Term.html" title="struct tantivy::schema::Term">Term</a>><br>) -> <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h4></section></summary><div class="docblock"><p>Creates a new <code>RangeQuery</code> from bounded start and end terms.</p> |
| <p>If the value type is not correct, something may go terribly wrong when |
| the <code>Weight</code> object is created.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_i64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#111-117">source</a><h4 class="code-header">pub fn <a href="#method.new_i64" class="fnname">new_i64</a>(field: <a class="struct" href="../schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>, range: Range<i64>) -> <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h4></section></summary><div class="docblock"><p>Creates a new <code>RangeQuery</code> over a <code>i64</code> field.</p> |
| <p>If the field is not of the type <code>i64</code>, tantivy |
| will panic when the <code>Weight</code> object is created.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_i64_bounds" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#126-138">source</a><h4 class="code-header">pub fn <a href="#method.new_i64_bounds" class="fnname">new_i64_bounds</a>(<br> field: <a class="struct" href="../schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>,<br> left_bound: Bound<i64>,<br> right_bound: Bound<i64><br>) -> <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h4></section></summary><div class="docblock"><p>Create a new <code>RangeQuery</code> over a <code>i64</code> field.</p> |
| <p>The two <code>Bound</code> arguments make it possible to create more complex |
| ranges than semi-inclusive range.</p> |
| <p>If the field is not of the type <code>i64</code>, tantivy |
| will panic when the <code>Weight</code> object is created.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_f64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#144-150">source</a><h4 class="code-header">pub fn <a href="#method.new_f64" class="fnname">new_f64</a>(field: <a class="struct" href="../schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>, range: Range<f64>) -> <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h4></section></summary><div class="docblock"><p>Creates a new <code>RangeQuery</code> over a <code>f64</code> field.</p> |
| <p>If the field is not of the type <code>f64</code>, tantivy |
| will panic when the <code>Weight</code> object is created.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_f64_bounds" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#159-171">source</a><h4 class="code-header">pub fn <a href="#method.new_f64_bounds" class="fnname">new_f64_bounds</a>(<br> field: <a class="struct" href="../schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>,<br> left_bound: Bound<f64>,<br> right_bound: Bound<f64><br>) -> <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h4></section></summary><div class="docblock"><p>Create a new <code>RangeQuery</code> over a <code>f64</code> field.</p> |
| <p>The two <code>Bound</code> arguments make it possible to create more complex |
| ranges than semi-inclusive range.</p> |
| <p>If the field is not of the type <code>f64</code>, tantivy |
| will panic when the <code>Weight</code> object is created.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_u64_bounds" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#180-192">source</a><h4 class="code-header">pub fn <a href="#method.new_u64_bounds" class="fnname">new_u64_bounds</a>(<br> field: <a class="struct" href="../schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>,<br> left_bound: Bound<u64>,<br> right_bound: Bound<u64><br>) -> <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h4></section></summary><div class="docblock"><p>Create a new <code>RangeQuery</code> over a <code>u64</code> field.</p> |
| <p>The two <code>Bound</code> arguments make it possible to create more complex |
| ranges than semi-inclusive range.</p> |
| <p>If the field is not of the type <code>u64</code>, tantivy |
| will panic when the <code>Weight</code> object is created.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_u64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#198-204">source</a><h4 class="code-header">pub fn <a href="#method.new_u64" class="fnname">new_u64</a>(field: <a class="struct" href="../schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>, range: Range<u64>) -> <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h4></section></summary><div class="docblock"><p>Create a new <code>RangeQuery</code> over a <code>u64</code> field.</p> |
| <p>If the field is not of the type <code>u64</code>, tantivy |
| will panic when the <code>Weight</code> object is created.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_str_bounds" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#213-221">source</a><h4 class="code-header">pub fn <a href="#method.new_str_bounds" class="fnname">new_str_bounds</a>(<br> field: <a class="struct" href="../schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>,<br> left: Bound<&str>,<br> right: Bound<&str><br>) -> <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h4></section></summary><div class="docblock"><p>Create a new <code>RangeQuery</code> over a <code>Str</code> field.</p> |
| <p>The two <code>Bound</code> arguments make it possible to create more complex |
| ranges than semi-inclusive range.</p> |
| <p>If the field is not of the type <code>Str</code>, tantivy |
| will panic when the <code>Weight</code> object is created.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_str" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#227-233">source</a><h4 class="code-header">pub fn <a href="#method.new_str" class="fnname">new_str</a>(field: <a class="struct" href="../schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>, range: Range<&str>) -> <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h4></section></summary><div class="docblock"><p>Create a new <code>RangeQuery</code> over a <code>Str</code> field.</p> |
| <p>If the field is not of the type <code>Str</code>, tantivy |
| will panic when the <code>Weight</code> object is created.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.field" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#236-238">source</a><h4 class="code-header">pub fn <a href="#method.field" class="fnname">field</a>(&self) -> <a class="struct" href="../schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a></h4></section></summary><div class="docblock"><p>Field to search over</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.left_bound" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#241-245">source</a><h4 class="code-header">pub fn <a href="#method.left_bound" class="fnname">left_bound</a>(&self) -> Bound<<a class="struct" href="../schema/struct.Term.html" title="struct tantivy::schema::Term">Term</a>></h4></section></summary><div class="docblock"><p>Lower bound of range</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.right_bound" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#248-252">source</a><h4 class="code-header">pub fn <a href="#method.right_bound" class="fnname">right_bound</a>(&self) -> Bound<<a class="struct" href="../schema/struct.Term.html" title="struct tantivy::schema::Term">Term</a>></h4></section></summary><div class="docblock"><p>Upper bound of range</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-RangeQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#76">source</a><a href="#impl-Clone-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#76">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&self) -> <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-RangeQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#76">source</a><a href="#impl-Debug-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#76">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Query-for-RangeQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#255-282">source</a><a href="#impl-Query-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Query.html" title="trait tantivy::query::Query">Query</a> for <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.weight" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/range_query.rs.html#256-281">source</a><a href="#method.weight" class="anchor"></a><h4 class="code-header">fn <a href="trait.Query.html#tymethod.weight" class="fnname">weight</a>(&self, enable_scoring: <a class="enum" href="enum.EnableScoring.html" title="enum tantivy::query::EnableScoring">EnableScoring</a><'_>) -> <a class="type" href="../type.Result.html" title="type tantivy::Result">Result</a><Box<dyn <a class="trait" href="trait.Weight.html" title="trait tantivy::query::Weight">Weight</a>>></h4></section></summary><div class='docblock'>Create the weight associated with a query. <a href="trait.Query.html#tymethod.weight">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.explain" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/query.rs.html#83-87">source</a><a href="#method.explain" class="anchor"></a><h4 class="code-header">fn <a href="trait.Query.html#method.explain" class="fnname">explain</a>(<br> &self,<br> searcher: &<a class="struct" href="../struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>,<br> doc_address: <a class="struct" href="../struct.DocAddress.html" title="struct tantivy::DocAddress">DocAddress</a><br>) -> <a class="type" href="../type.Result.html" title="type tantivy::Result">Result</a><<a class="struct" href="struct.Explanation.html" title="struct tantivy::query::Explanation">Explanation</a>></h4></section></summary><div class='docblock'>Returns an <code>Explanation</code> for the score of the document.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.count" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/query.rs.html#90-97">source</a><a href="#method.count" class="anchor"></a><h4 class="code-header">fn <a href="trait.Query.html#method.count" class="fnname">count</a>(&self, searcher: &<a class="struct" href="../struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -> <a class="type" href="../type.Result.html" title="type tantivy::Result">Result</a><usize></h4></section></summary><div class='docblock'>Returns the number of documents matching the query.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.query_terms" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/query.rs.html#107">source</a><a href="#method.query_terms" class="anchor"></a><h4 class="code-header">fn <a href="trait.Query.html#method.query_terms" class="fnname">query_terms</a><'a>(&'a self, _visitor: &mut dyn FnMut(&'a <a class="struct" href="../schema/struct.Term.html" title="struct tantivy::schema::Term">Term</a>, bool))</h4></section></summary><div class='docblock'>Extract all of the terms associated with the query and pass them to the |
| given closure. <a href="trait.Query.html#method.query_terms">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-RangeQuery" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h3></section><section id="impl-Send-for-RangeQuery" class="impl has-srclink"><a href="#impl-Send-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h3></section><section id="impl-Sync-for-RangeQuery" class="impl has-srclink"><a href="#impl-Sync-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h3></section><section id="impl-Unpin-for-RangeQuery" class="impl has-srclink"><a href="#impl-Unpin-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h3></section><section id="impl-UnwindSafe-for-RangeQuery" class="impl has-srclink"><a href="#impl-UnwindSafe-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.RangeQuery.html" title="struct tantivy::query::RangeQuery">RangeQuery</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-RangeQuery" class="impl has-srclink"><a href="#impl-Any-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-RangeQuery" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-RangeQuery" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Downcast-for-RangeQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#190">source</a><a href="#impl-Downcast-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../downcast_rs/trait.Downcast.html" title="trait downcast_rs::Downcast">Downcast</a> for T<span class="where fmt-newline">where<br> T: Any,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#191">source</a><a href="#method.into_any" class="anchor"></a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.into_any" class="fnname">into_any</a>(self: Box<T, Global>) -> Box<dyn Any + 'static, Global></h4></section></summary><div class='docblock'>Convert <code>Box<dyn Trait></code> (where <code>Trait: Downcast</code>) to <code>Box<dyn Any></code>. <code>Box<dyn Any></code> can |
| then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="../../downcast_rs/trait.Downcast.html#tymethod.into_any">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any_rc" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#192">source</a><a href="#method.into_any_rc" class="anchor"></a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.into_any_rc" class="fnname">into_any_rc</a>(self: Rc<T>) -> Rc<dyn Any + 'static></h4></section></summary><div class='docblock'>Convert <code>Rc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Rc<Any></code>. <code>Rc<Any></code> can then be |
| further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="../../downcast_rs/trait.Downcast.html#tymethod.into_any_rc">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_any" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#193">source</a><a href="#method.as_any" class="anchor"></a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.as_any" class="fnname">as_any</a>(&self) -> &(dyn Any + 'static)</h4></section></summary><div class='docblock'>Convert <code>&Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot |
| generate <code>&Any</code>’s vtable from <code>&Trait</code>’s. <a href="../../downcast_rs/trait.Downcast.html#tymethod.as_any">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_any_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#194">source</a><a href="#method.as_any_mut" class="anchor"></a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.as_any_mut" class="fnname">as_any_mut</a>(&mut self) -> &mut (dyn Any + 'static)</h4></section></summary><div class='docblock'>Convert <code>&mut Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot |
| generate <code>&mut Any</code>’s vtable from <code>&mut Trait</code>’s. <a href="../../downcast_rs/trait.Downcast.html#tymethod.as_any_mut">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-DowncastSync-for-RangeQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#204">source</a><a href="#impl-DowncastSync-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../downcast_rs/trait.DowncastSync.html" title="trait downcast_rs::DowncastSync">DowncastSync</a> for T<span class="where fmt-newline">where<br> T: Any + Send + Sync,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any_arc" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#205">source</a><a href="#method.into_any_arc" class="anchor"></a><h4 class="code-header">fn <a href="../../downcast_rs/trait.DowncastSync.html#tymethod.into_any_arc" class="fnname">into_any_arc</a>(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static></h4></section></summary><div class='docblock'>Convert <code>Arc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Arc<Any></code>. <code>Arc<Any></code> can then be |
| further <code>downcast</code> into <code>Arc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="../../downcast_rs/trait.DowncastSync.html#tymethod.into_any_arc">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-RangeQuery" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-RangeQuery" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Pointable-for-RangeQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#194">source</a><a href="#impl-Pointable-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../crossbeam_epoch/atomic/trait.Pointable.html" title="trait crossbeam_epoch::atomic::Pointable">Pointable</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedconstant.ALIGN" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#195">source</a><a href="#associatedconstant.ALIGN" class="anchor"></a><h4 class="code-header">const <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#associatedconstant.ALIGN" class="constant">ALIGN</a>: usize = mem::align_of::<T>()</h4></section></summary><div class='docblock'>The alignment of pointer.</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.Init" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Init" class="anchor"></a><h4 class="code-header">type <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#associatedtype.Init" class="associatedtype">Init</a> = T</h4></section></summary><div class='docblock'>The type for initializers.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.init" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#199">source</a><a href="#method.init" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.init" class="fnname">init</a>(init: <T as <a class="trait" href="../../crossbeam_epoch/atomic/trait.Pointable.html" title="trait crossbeam_epoch::atomic::Pointable">Pointable</a>>::<a class="associatedtype" href="../../crossbeam_epoch/atomic/trait.Pointable.html#associatedtype.Init" title="type crossbeam_epoch::atomic::Pointable::Init">Init</a>) -> usize</h4></section></summary><div class='docblock'>Initializes a with the given initializer. <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.init">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#203">source</a><a href="#method.deref" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref" class="fnname">deref</a><'a>(ptr: usize) -> &'a T</h4></section></summary><div class='docblock'>Dereferences the given pointer. <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#207">source</a><a href="#method.deref_mut" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref_mut" class="fnname">deref_mut</a><'a>(ptr: usize) -> &'a mut T</h4></section></summary><div class='docblock'>Mutably dereferences the given pointer. <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref_mut">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#211">source</a><a href="#method.drop" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.drop" class="fnname">drop</a>(ptr: usize)</h4></section></summary><div class='docblock'>Drops the object pointed to by the given pointer. <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.drop">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-RangeQuery" class="impl has-srclink"><a href="#impl-ToOwned-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T> ToOwned for T<span class="where fmt-newline">where<br> T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&self, target: &mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-RangeQuery" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-RangeQuery" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-RangeQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/ppv_lite86/types.rs.html#221">source</a><a href="#impl-VZip%3CV%3E-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<V, T> <a class="trait" href="../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a><V> for T<span class="where fmt-newline">where<br> V: <a class="trait" href="../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a><T>,</span></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/ppv_lite86/types.rs.html#226">source</a><a href="#method.vzip" class="anchor"></a><h4 class="code-header">fn <a href="../../ppv_lite86/types/trait.VZip.html#tymethod.vzip" class="fnname">vzip</a>(self) -> V</h4></section></div></details><section id="impl-Fruit-for-RangeQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#122">source</a><a href="#impl-Fruit-for-RangeQuery" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../collector/trait.Fruit.html" title="trait tantivy::collector::Fruit">Fruit</a> for T<span class="where fmt-newline">where<br> T: Send + <a class="trait" href="../../downcast_rs/trait.Downcast.html" title="trait downcast_rs::Downcast">Downcast</a>,</span></h3></section></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
