mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-25 12:40:41 +00:00
162 lines
15 KiB
HTML
162 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 `Exclude` struct in crate `tantivy`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Exclude">
|
||
|
||
<title>tantivy::query::Exclude - 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 Exclude</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-DocSet">DocSet</a><a href="#impl-Scorer">Scorer</a></div></div><p class='location'><a href='../index.html'>tantivy</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'Exclude', 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=''>Exclude</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/exclude.rs.html#15-19' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Exclude<TDocSet, TDocSetExclude> { /* fields omitted */ }</pre><div class='docblock'><p>Filters a given <code>DocSet</code> by removing the docs from a given <code>DocSet</code>.</p>
|
||
<p>The excluding docset has no impact on scoring.</p>
|
||
</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<TDocSet, TDocSetExclude> <a class="struct" href="../../tantivy/query/struct.Exclude.html" title="struct tantivy::query::Exclude">Exclude</a><TDocSet, TDocSetExclude> <span class="where fmt-newline">where<br> TDocSetExclude: <a class="trait" href="../../tantivy/trait.DocSet.html" title="trait tantivy::DocSet">DocSet</a>, </span></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/exclude.rs.html#21-41' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(<br> underlying_docset: TDocSet, <br> excluding_docset: TDocSetExclude<br>) -> <a class="struct" href="../../tantivy/query/struct.Exclude.html" title="struct tantivy::query::Exclude">Exclude</a><TDocSet, TDocSetExclude></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/exclude.rs.html#26-40' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new <code>ExcludeScorer</code></p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-DocSet' class='impl'><span class='in-band'><code>impl<TDocSet, TDocSetExclude> <a class="trait" href="../../tantivy/trait.DocSet.html" title="trait tantivy::DocSet">DocSet</a> for <a class="struct" href="../../tantivy/query/struct.Exclude.html" title="struct tantivy::query::Exclude">Exclude</a><TDocSet, TDocSetExclude> <span class="where fmt-newline">where<br> TDocSet: <a class="trait" href="../../tantivy/trait.DocSet.html" title="trait tantivy::DocSet">DocSet</a>,<br> TDocSetExclude: <a class="trait" href="../../tantivy/trait.DocSet.html" title="trait tantivy::DocSet">DocSet</a>, </span></code><a href='#impl-DocSet' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/exclude.rs.html#79-117' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.advance' class="method"><span id='advance.v' class='invisible'><code>fn <a href='../../tantivy/trait.DocSet.html#tymethod.advance' class='fnname'>advance</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/exclude.rs.html#84-91' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Goes to the next element. <code>.advance(...)</code> needs to be called a first time to point to the correct element. <a href="../../tantivy/trait.DocSet.html#tymethod.advance">Read more</a></p>
|
||
</div><h4 id='method.skip_next' class="method"><span id='skip_next.v' class='invisible'><code>fn <a href='../../tantivy/trait.DocSet.html#method.skip_next' class='fnname'>skip_next</a>(&mut self, target: <a class="type" href="../../tantivy/type.DocId.html" title="type tantivy::DocId">DocId</a>) -> <a class="enum" href="../../tantivy/enum.SkipResult.html" title="enum tantivy::SkipResult">SkipResult</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/exclude.rs.html#93-105' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>After skipping, position the iterator in such a way that <code>.doc()</code> will return a value greater than or equal to target. <a href="../../tantivy/trait.DocSet.html#method.skip_next">Read more</a></p>
|
||
</div><h4 id='method.doc' class="method"><span id='doc.v' class='invisible'><code>fn <a href='../../tantivy/trait.DocSet.html#tymethod.doc' class='fnname'>doc</a>(&self) -> <a class="type" href="../../tantivy/type.DocId.html" title="type tantivy::DocId">DocId</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/exclude.rs.html#107-109' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the current document</p>
|
||
</div><h4 id='method.size_hint' class="method"><span id='size_hint.v' class='invisible'><code>fn <a href='../../tantivy/trait.DocSet.html#tymethod.size_hint' class='fnname'>size_hint</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/exclude.rs.html#114-116' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p><code>.size_hint()</code> directly returns the size
|
||
of the underlying docset without taking in account
|
||
the fact that docs might be deleted.</p>
|
||
</div><h4 id='method.fill_buffer' class="method"><span id='fill_buffer.v' class='invisible'><code>fn <a href='../../tantivy/trait.DocSet.html#method.fill_buffer' class='fnname'>fill_buffer</a>(&mut self, buffer: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="type" href="../../tantivy/type.DocId.html" title="type tantivy::DocId">DocId</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</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/docset.rs.html#72-81' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Fills a given mutable buffer with the next doc ids from the <code>DocSet</code> <a href="../../tantivy/trait.DocSet.html#method.fill_buffer">Read more</a></p>
|
||
</div><h4 id='method.append_to_bitset' class="method"><span id='append_to_bitset.v' class='invisible'><code>fn <a href='../../tantivy/trait.DocSet.html#method.append_to_bitset' class='fnname'>append_to_bitset</a>(&mut self, bitset: &mut BitSet)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/docset.rs.html#91-95' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Appends all docs to a <code>bitset</code>.</p>
|
||
</div><h4 id='method.count' class="method"><span id='count.v' class='invisible'><code>fn <a href='../../tantivy/trait.DocSet.html#method.count' class='fnname'>count</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/docset.rs.html#100-106' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the number documents matching. <a href="../../tantivy/trait.DocSet.html#method.count">Read more</a></p>
|
||
</div></div><h3 id='impl-Scorer' class='impl'><span class='in-band'><code>impl<TScorer, TDocSetExclude> <a class="trait" href="../../tantivy/query/trait.Scorer.html" title="trait tantivy::query::Scorer">Scorer</a> for <a class="struct" href="../../tantivy/query/struct.Exclude.html" title="struct tantivy::query::Exclude">Exclude</a><TScorer, TDocSetExclude> <span class="where fmt-newline">where<br> TScorer: <a class="trait" href="../../tantivy/query/trait.Scorer.html" title="trait tantivy::query::Scorer">Scorer</a>,<br> TDocSetExclude: <a class="trait" href="../../tantivy/trait.DocSet.html" title="trait tantivy::DocSet">DocSet</a> + 'static, </span></code><a href='#impl-Scorer' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/exclude.rs.html#119-127' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.score' class="method"><span id='score.v' class='invisible'><code>fn <a href='../../tantivy/query/trait.Scorer.html#tymethod.score' class='fnname'>score</a>(&mut self) -> <a class="type" href="../../tantivy/type.Score.html" title="type tantivy::Score">Score</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/exclude.rs.html#124-126' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the score. <a href="../../tantivy/query/trait.Scorer.html#tymethod.score">Read more</a></p>
|
||
</div><h4 id='method.collect' class="method"><span id='collect.v' class='invisible'><code>fn <a href='../../tantivy/query/trait.Scorer.html#method.collect' class='fnname'>collect</a>(&mut self, collector: &mut <a class="trait" href="../../tantivy/collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tantivy/query/scorer.rs.html#20-24' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Consumes the complete <code>DocSet</code> and push the scored documents to the collector. <a href="../../tantivy/query/trait.Scorer.html#method.collect">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> |