mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-24 20:20:44 +00:00
163 lines
15 KiB
HTML
163 lines
15 KiB
HTML
<!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="../../main.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">☰</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<Vec<(Occur, Box<Query>)>></a><a href="#impl-Query">Query</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">
|
||
</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'>−</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>
|
||
<pre class='rust struct'>pub struct BooleanQuery { /* fields omitted */ }</pre><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>
|
||
<li>match all of the sub queries associated with the
|
||
<code>Must</code> occurence</li>
|
||
<li>match none of the sub queries associated with the
|
||
<code>MustNot</code> occurence.</li>
|
||
<li>match at least one of the subqueries that is not
|
||
a <code>MustNot</code> occurence.</li>
|
||
</ul>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#44-57' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new_multiterms_query' class="method"><span id='new_multiterms_query.v' class='invisible'><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><<a class="struct" href="../../tantivy/struct.Term.html" title="struct tantivy::Term">Term</a>>) -> <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/boolean_query/boolean_query.rs.html#47-56' title='goto source code'>[src]</a></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>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-Debug' class='impl'><span class='in-band'><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><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></h3>
|
||
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><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></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'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</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><<a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a>><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>> 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><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></h3>
|
||
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><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><<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><<a class="trait" href="../../tantivy/query/trait.Query.html" title="trait tantivy::query::Query">Query</a>><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>) -> <a class="struct" href="../../tantivy/query/struct.BooleanQuery.html" title="struct tantivy::query::BooleanQuery">BooleanQuery</a></code></span><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></span></h4>
|
||
<div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Query' class='impl'><span class='in-band'><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><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></h3>
|
||
<div class='impl-items'><h4 id='method.weight' class="method"><span id='weight.v' class='invisible'><code>fn <a href='../../tantivy/query/trait.Query.html#tymethod.weight' class='fnname'>weight</a>(<br> &self, <br> searcher: &<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, <br> scoring_enabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -> <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="trait" href="../../tantivy/query/trait.Weight.html" title="trait tantivy::query::Weight">Weight</a>>></code></span><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></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'><code>fn <a href='../../tantivy/query/trait.Query.html#method.count' class='fnname'>count</a>(&self, searcher: &<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>) -> <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code></span><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></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'><code>fn <a href='../../tantivy/query/trait.Query.html#method.search' class='fnname'>search</a>(<br> &self, <br> searcher: &<a class="struct" href="../../tantivy/struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a>, <br> collector: &mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a><br>) -> <a class="type" href="../../tantivy/type.Result.html" title="type tantivy::Result">Result</a><<a class="struct" href="../../tantivy/struct.TimerTree.html" title="struct tantivy::TimerTree">TimerTree</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/query.rs.html#70-90' title='goto source code'>[src]</a></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></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>⏎</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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../";
|
||
window.currentCrate = "tantivy";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |