blob: c74250b5077a25a4cfbd13efab76bf8338892873 [file] [log] [blame]
<!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="The disjunction max query кeturns documents matching one or more wrapped queries, called query clauses or clauses."><meta name="keywords" content="rust, rustlang, rust-lang, DisjunctionMaxQuery"><title>DisjunctionMaxQuery 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">&#9776;</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="#">DisjunctionMaxQuery</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.new">new</a></li><li><a href="#method.with_tie_breaker">with_tie_breaker</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-DisjunctionMaxQuery">Clone</a></li><li><a href="#impl-Debug-for-DisjunctionMaxQuery">Debug</a></li><li><a href="#impl-Query-for-DisjunctionMaxQuery">Query</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-DisjunctionMaxQuery">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-DisjunctionMaxQuery">Send</a></li><li><a href="#impl-Sync-for-DisjunctionMaxQuery">Sync</a></li><li><a href="#impl-Unpin-for-DisjunctionMaxQuery">Unpin</a></li><li><a href="#impl-UnwindSafe-for-DisjunctionMaxQuery">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-DisjunctionMaxQuery">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-DisjunctionMaxQuery">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-DisjunctionMaxQuery">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-Downcast-for-DisjunctionMaxQuery">Downcast</a></li><li><a href="#impl-DowncastSync-for-DisjunctionMaxQuery">DowncastSync</a></li><li><a href="#impl-From%3CT%3E-for-DisjunctionMaxQuery">From&lt;T&gt;</a></li><li><a href="#impl-Fruit-for-DisjunctionMaxQuery">Fruit</a></li><li><a href="#impl-Into%3CU%3E-for-DisjunctionMaxQuery">Into&lt;U&gt;</a></li><li><a href="#impl-Pointable-for-DisjunctionMaxQuery">Pointable</a></li><li><a href="#impl-ToOwned-for-DisjunctionMaxQuery">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-DisjunctionMaxQuery">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-DisjunctionMaxQuery">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-DisjunctionMaxQuery">VZip&lt;V&gt;</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="#">DisjunctionMaxQuery</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/disjunction_max_query.rs.html#76-79">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct DisjunctionMaxQuery { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The disjunction max query кeturns documents matching one or more wrapped queries,
called query clauses or clauses.</p>
<p>If a returned document matches multiple query clauses,
the <code>DisjunctionMaxQuery</code> assigns the document the highest relevance score from any matching
clause, plus a tie breaking increment for any additional matching subqueries.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tantivy::collector::TopDocs;
<span class="kw">use </span>tantivy::doc;
<span class="kw">use </span>tantivy::query::{DisjunctionMaxQuery, Query, QueryClone, TermQuery};
<span class="kw">use </span>tantivy::schema::{IndexRecordOption, Schema, TEXT};
<span class="kw">use </span>tantivy::Term;
<span class="kw">use </span>tantivy::Index;
<span class="kw">fn </span>main() -&gt; tantivy::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>title = schema_builder.add_text_field(<span class="string">&quot;title&quot;</span>, TEXT);
<span class="kw">let </span>body = schema_builder.add_text_field(<span class="string">&quot;body&quot;</span>, TEXT);
<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(<span class="number">3_000_000</span>)<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(
title =&gt; <span class="string">&quot;The Name of Girl&quot;</span>,
))<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(
title =&gt; <span class="string">&quot;The Diary of Muadib&quot;</span>,
))<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(
title =&gt; <span class="string">&quot;The Diary of Girl&quot;</span>,
))<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="comment">// Make TermQuery&#39;s for &quot;girl&quot; and &quot;diary&quot; in the title
</span><span class="kw">let </span>girl_term_query: Box&lt;<span class="kw">dyn </span>Query&gt; = Box::new(TermQuery::new(
Term::from_field_text(title, <span class="string">&quot;girl&quot;</span>),
IndexRecordOption::Basic,
));
<span class="kw">let </span>diary_term_query: Box&lt;<span class="kw">dyn </span>Query&gt; = Box::new(TermQuery::new(
Term::from_field_text(title, <span class="string">&quot;diary&quot;</span>),
IndexRecordOption::Basic,
));
<span class="comment">// TermQuery &quot;diary&quot; and &quot;girl&quot; should be present and only one should be accounted in score
</span><span class="kw">let </span>queries1 = <span class="macro">vec!</span>[diary_term_query.box_clone(), girl_term_query.box_clone()];
<span class="kw">let </span>diary_and_girl = DisjunctionMaxQuery::new(queries1);
<span class="kw">let </span>documents = searcher.search(<span class="kw-2">&amp;</span>diary_and_girl, <span class="kw-2">&amp;</span>TopDocs::with_limit(<span class="number">3</span>))<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(documents[<span class="number">0</span>].<span class="number">0</span>, documents[<span class="number">1</span>].<span class="number">0</span>);
<span class="macro">assert_eq!</span>(documents[<span class="number">1</span>].<span class="number">0</span>, documents[<span class="number">2</span>].<span class="number">0</span>);
<span class="comment">// TermQuery &quot;diary&quot; and &quot;girl&quot; should be present
// and one should be accounted with multiplier 0.7
</span><span class="kw">let </span>queries2 = <span class="macro">vec!</span>[diary_term_query.box_clone(), girl_term_query.box_clone()];
<span class="kw">let </span>tie_breaker = <span class="number">0.7</span>;
<span class="kw">let </span>diary_and_girl_with_tie_breaker = DisjunctionMaxQuery::with_tie_breaker(queries2, tie_breaker);
<span class="kw">let </span>documents = searcher.search(<span class="kw-2">&amp;</span>diary_and_girl_with_tie_breaker, <span class="kw-2">&amp;</span>TopDocs::with_limit(<span class="number">3</span>))<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(documents[<span class="number">1</span>].<span class="number">0</span>, documents[<span class="number">2</span>].<span class="number">0</span>);
<span class="comment">// For this test all terms brings the same score. So we can do easy math and assume that
// `DisjunctionMaxQuery` with tie breakers score should be equal
// to term1 score + `tie_breaker` * term2 score or (1.0 + tie_breaker) * term score
</span><span class="macro">assert!</span>(f32::abs(documents[<span class="number">0</span>].<span class="number">0 </span>- documents[<span class="number">1</span>].<span class="number">0 </span>* (<span class="number">1.0 </span>+ tie_breaker)) &lt; <span class="number">0.001</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-DisjunctionMaxQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/disjunction_max_query.rs.html#115-131">source</a><a href="#impl-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.DisjunctionMaxQuery.html" title="struct tantivy::query::DisjunctionMaxQuery">DisjunctionMaxQuery</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_tie_breaker" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/disjunction_max_query.rs.html#117-125">source</a><h4 class="code-header">pub fn <a href="#method.with_tie_breaker" class="fnname">with_tie_breaker</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;disjuncts: Vec&lt;Box&lt;dyn <a class="trait" href="trait.Query.html" title="trait tantivy::query::Query">Query</a>&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;tie_breaker: <a class="type" href="../type.Score.html" title="type tantivy::Score">Score</a><br>) -&gt; <a class="struct" href="struct.DisjunctionMaxQuery.html" title="struct tantivy::query::DisjunctionMaxQuery">DisjunctionMaxQuery</a></h4></section></summary><div class="docblock"><p>Creates a new <code>DisjunctionMaxQuery</code> with tie breaker.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/disjunction_max_query.rs.html#128-130">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(disjuncts: Vec&lt;Box&lt;dyn <a class="trait" href="trait.Query.html" title="trait tantivy::query::Query">Query</a>&gt;&gt;) -&gt; <a class="struct" href="struct.DisjunctionMaxQuery.html" title="struct tantivy::query::DisjunctionMaxQuery">DisjunctionMaxQuery</a></h4></section></summary><div class="docblock"><p>Creates a new <code>DisjunctionMaxQuery</code> with no tie breaker.</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-DisjunctionMaxQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/disjunction_max_query.rs.html#81-91">source</a><a href="#impl-Clone-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.DisjunctionMaxQuery.html" title="struct tantivy::query::DisjunctionMaxQuery">DisjunctionMaxQuery</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/disjunction_max_query.rs.html#82-90">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&amp;self) -&gt; Self</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>(&amp;mut self, source: &amp;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-DisjunctionMaxQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/disjunction_max_query.rs.html#75">source</a><a href="#impl-Debug-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.DisjunctionMaxQuery.html" title="struct tantivy::query::DisjunctionMaxQuery">DisjunctionMaxQuery</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/disjunction_max_query.rs.html#75">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, f: &amp;mut Formatter&lt;'_&gt;) -&gt; 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-DisjunctionMaxQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/disjunction_max_query.rs.html#93-113">source</a><a href="#impl-Query-for-DisjunctionMaxQuery" 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.DisjunctionMaxQuery.html" title="struct tantivy::query::DisjunctionMaxQuery">DisjunctionMaxQuery</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/disjunction_max_query.rs.html#94-106">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>(&amp;self, enable_scoring: <a class="enum" href="enum.EnableScoring.html" title="enum tantivy::query::EnableScoring">EnableScoring</a>&lt;'_&gt;) -&gt; <a class="type" href="../type.Result.html" title="type tantivy::Result">Result</a>&lt;Box&lt;dyn <a class="trait" href="trait.Weight.html" title="trait tantivy::query::Weight">Weight</a>&gt;&gt;</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.query_terms" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/disjunction_max_query.rs.html#108-112">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>&lt;'a&gt;(&amp;'a self, visitor: &amp;mut dyn FnMut(&amp;'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><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>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;searcher: &amp;<a class="struct" href="../struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;doc_address: <a class="struct" href="../struct.DocAddress.html" title="struct tantivy::DocAddress">DocAddress</a><br>) -&gt; <a class="type" href="../type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="struct.Explanation.html" title="struct tantivy::query::Explanation">Explanation</a>&gt;</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>(&amp;self, searcher: &amp;<a class="struct" href="../struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -&gt; <a class="type" href="../type.Result.html" title="type tantivy::Result">Result</a>&lt;usize&gt;</h4></section></summary><div class='docblock'>Returns the number of documents matching the query.</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-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl !RefUnwindSafe for <a class="struct" href="struct.DisjunctionMaxQuery.html" title="struct tantivy::query::DisjunctionMaxQuery">DisjunctionMaxQuery</a></h3></section><section id="impl-Send-for-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-Send-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.DisjunctionMaxQuery.html" title="struct tantivy::query::DisjunctionMaxQuery">DisjunctionMaxQuery</a></h3></section><section id="impl-Sync-for-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-Sync-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.DisjunctionMaxQuery.html" title="struct tantivy::query::DisjunctionMaxQuery">DisjunctionMaxQuery</a></h3></section><section id="impl-Unpin-for-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-Unpin-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.DisjunctionMaxQuery.html" title="struct tantivy::query::DisjunctionMaxQuery">DisjunctionMaxQuery</a></h3></section><section id="impl-UnwindSafe-for-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-UnwindSafe-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl !UnwindSafe for <a class="struct" href="struct.DisjunctionMaxQuery.html" title="struct tantivy::query::DisjunctionMaxQuery">DisjunctionMaxQuery</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-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-Any-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>(&amp;self) -&gt; 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-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>(&amp;self) -&gt; &amp;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-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>(&amp;mut self) -&gt; &amp;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-DisjunctionMaxQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#190">source</a><a href="#impl-Downcast-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <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>&nbsp;&nbsp;&nbsp;&nbsp;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&lt;T, Global&gt;) -&gt; Box&lt;dyn Any + 'static, Global&gt;</h4></section></summary><div class='docblock'>Convert <code>Box&lt;dyn Trait&gt;</code> (where <code>Trait: Downcast</code>) to <code>Box&lt;dyn Any&gt;</code>. <code>Box&lt;dyn Any&gt;</code> can
then be further <code>downcast</code> into <code>Box&lt;ConcreteType&gt;</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&lt;T&gt;) -&gt; Rc&lt;dyn Any + 'static&gt;</h4></section></summary><div class='docblock'>Convert <code>Rc&lt;Trait&gt;</code> (where <code>Trait: Downcast</code>) to <code>Rc&lt;Any&gt;</code>. <code>Rc&lt;Any&gt;</code> can then be
further <code>downcast</code> into <code>Rc&lt;ConcreteType&gt;</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>(&amp;self) -&gt; &amp;(dyn Any + 'static)</h4></section></summary><div class='docblock'>Convert <code>&amp;Trait</code> (where <code>Trait: Downcast</code>) to <code>&amp;Any</code>. This is needed since Rust cannot
generate <code>&amp;Any</code>’s vtable from <code>&amp;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>(&amp;mut self) -&gt; &amp;mut (dyn Any + 'static)</h4></section></summary><div class='docblock'>Convert <code>&amp;mut Trait</code> (where <code>Trait: Downcast</code>) to <code>&amp;Any</code>. This is needed since Rust cannot
generate <code>&amp;mut Any</code>’s vtable from <code>&amp;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-DisjunctionMaxQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#204">source</a><a href="#impl-DowncastSync-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <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>&nbsp;&nbsp;&nbsp;&nbsp;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&lt;T&gt;) -&gt; Arc&lt;dyn Any + Sync + Send + 'static&gt;</h4></section></summary><div class='docblock'>Convert <code>Arc&lt;Trait&gt;</code> (where <code>Trait: Downcast</code>) to <code>Arc&lt;Any&gt;</code>. <code>Arc&lt;Any&gt;</code> can then be
further <code>downcast</code> into <code>Arc&lt;ConcreteType&gt;</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-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; 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) -&gt; 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-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</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) -&gt; 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]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Pointable-for-DisjunctionMaxQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#194">source</a><a href="#impl-Pointable-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <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::&lt;T&gt;()</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: &lt;T as <a class="trait" href="../../crossbeam_epoch/atomic/trait.Pointable.html" title="trait crossbeam_epoch::atomic::Pointable">Pointable</a>&gt;::<a class="associatedtype" href="../../crossbeam_epoch/atomic/trait.Pointable.html#associatedtype.Init" title="type crossbeam_epoch::atomic::Pointable::Init">Init</a>) -&gt; 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>&lt;'a&gt;(ptr: usize) -&gt; &amp;'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>&lt;'a&gt;(ptr: usize) -&gt; &amp;'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-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-ToOwned-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; ToOwned for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>(&amp;self) -&gt; 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>(&amp;self, target: &amp;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-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</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) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</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-DisjunctionMaxQuery" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</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> = &lt;U as TryFrom&lt;T&gt;&gt;::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) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</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-DisjunctionMaxQuery" 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-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;V, T&gt; <a class="trait" href="../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a>&lt;V&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a>&lt;T&gt;,</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) -&gt; V</h4></section></div></details><section id="impl-Fruit-for-DisjunctionMaxQuery" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#122">source</a><a href="#impl-Fruit-for-DisjunctionMaxQuery" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../collector/trait.Fruit.html" title="trait tantivy::collector::Fruit">Fruit</a> for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>