| <!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="Holds a list of `SegmentReader`s ready for search."><meta name="keywords" content="rust, rustlang, rust-lang, Searcher"><title>Searcher in tantivy - 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="#">Searcher</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.doc">doc</a></li><li><a href="#method.doc_freq">doc_freq</a></li><li><a href="#method.doc_store_cache_stats">doc_store_cache_stats</a></li><li><a href="#method.generation">generation</a></li><li><a href="#method.index">index</a></li><li><a href="#method.num_docs">num_docs</a></li><li><a href="#method.schema">schema</a></li><li><a href="#method.search">search</a></li><li><a href="#method.search_with_executor">search_with_executor</a></li><li><a href="#method.segment_reader">segment_reader</a></li><li><a href="#method.segment_readers">segment_readers</a></li><li><a href="#method.space_usage">space_usage</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Searcher">Clone</a></li><li><a href="#impl-Debug-for-Searcher">Debug</a></li><li><a href="#impl-From%3CArc%3CSearcherInner%3E%3E-for-Searcher">From<Arc<SearcherInner>></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Searcher">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Searcher">Send</a></li><li><a href="#impl-Sync-for-Searcher">Sync</a></li><li><a href="#impl-Unpin-for-Searcher">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Searcher">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Searcher">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Searcher">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Searcher">BorrowMut<T></a></li><li><a href="#impl-Downcast-for-Searcher">Downcast</a></li><li><a href="#impl-DowncastSync-for-Searcher">DowncastSync</a></li><li><a href="#impl-From%3CT%3E-for-Searcher">From<T></a></li><li><a href="#impl-Fruit-for-Searcher">Fruit</a></li><li><a href="#impl-Into%3CU%3E-for-Searcher">Into<U></a></li><li><a href="#impl-Pointable-for-Searcher">Pointable</a></li><li><a href="#impl-ToOwned-for-Searcher">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Searcher">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Searcher">TryInto<U></a></li><li><a href="#impl-VZip%3CV%3E-for-Searcher">VZip<V></a></li></ul></section><h2><a href="index.html">In tantivy</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 class="struct" href="#">Searcher</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/core/searcher.rs.html#67-69">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 Searcher { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Holds a list of <code>SegmentReader</code>s ready for search.</p> |
| <p>It guarantees that the <code>Segment</code> will not be removed before |
| the destruction of the <code>Searcher</code>.</p> |
| </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-Searcher" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#71-226">source</a><a href="#impl-Searcher" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.index" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#73-75">source</a><h4 class="code-header">pub fn <a href="#method.index" class="fnname">index</a>(&self) -> &<a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</a></h4></section></summary><div class="docblock"><p>Returns the <code>Index</code> associated with the <code>Searcher</code></p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.generation" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#78-80">source</a><h4 class="code-header">pub fn <a href="#method.generation" class="fnname">generation</a>(&self) -> &<a class="struct" href="struct.SearcherGeneration.html" title="struct tantivy::SearcherGeneration">SearcherGeneration</a></h4></section></summary><div class="docblock"><p><a href="struct.SearcherGeneration.html" title="SearcherGeneration"><code>SearcherGeneration</code></a> which identifies the version of the snapshot held by this <code>Searcher</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.doc" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#86-89">source</a><h4 class="code-header">pub fn <a href="#method.doc" class="fnname">doc</a>(&self, doc_address: <a class="struct" href="struct.DocAddress.html" title="struct tantivy::DocAddress">DocAddress</a>) -> <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a><<a class="struct" href="schema/struct.Document.html" title="struct tantivy::schema::Document">Document</a>></h4></section></summary><div class="docblock"><p>Fetches a document from tantivy’s store given a <a href="struct.DocAddress.html" title="DocAddress"><code>DocAddress</code></a>.</p> |
| <p>The searcher uses the segment ordinal to route the |
| request to the right <code>Segment</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.doc_store_cache_stats" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#94-102">source</a><h4 class="code-header">pub fn <a href="#method.doc_store_cache_stats" class="fnname">doc_store_cache_stats</a>(&self) -> <a class="struct" href="store/struct.CacheStats.html" title="struct tantivy::store::CacheStats">CacheStats</a></h4></section></summary><div class="docblock"><p>The cache stats for the underlying store reader.</p> |
| <p>Aggregates the sum for each segment store reader.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.schema" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#112-114">source</a><h4 class="code-header">pub fn <a href="#method.schema" class="fnname">schema</a>(&self) -> &<a class="struct" href="schema/struct.Schema.html" title="struct tantivy::schema::Schema">Schema</a></h4></section></summary><div class="docblock"><p>Access the schema associated with the index of this searcher.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.num_docs" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#117-123">source</a><h4 class="code-header">pub fn <a href="#method.num_docs" class="fnname">num_docs</a>(&self) -> u64</h4></section></summary><div class="docblock"><p>Returns the overall number of documents in the index.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.doc_freq" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#127-135">source</a><h4 class="code-header">pub fn <a href="#method.doc_freq" class="fnname">doc_freq</a>(&self, term: &<a class="struct" href="schema/struct.Term.html" title="struct tantivy::schema::Term">Term</a>) -> <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a><u64></h4></section></summary><div class="docblock"><p>Return the overall number of documents containing |
| the given term.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.segment_readers" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#151-153">source</a><h4 class="code-header">pub fn <a href="#method.segment_readers" class="fnname">segment_readers</a>(&self) -> &[<a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a>]</h4></section></summary><div class="docblock"><p>Return the list of segment readers</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.segment_reader" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#156-158">source</a><h4 class="code-header">pub fn <a href="#method.segment_reader" class="fnname">segment_reader</a>(&self, segment_ord: u32) -> &<a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a></h4></section></summary><div class="docblock"><p>Returns the segment_reader associated with the given segment_ord</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.search" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#174-181">source</a><h4 class="code-header">pub fn <a href="#method.search" class="fnname">search</a><C: <a class="trait" href="collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>>(<br> &self,<br> query: &dyn <a class="trait" href="query/trait.Query.html" title="trait tantivy::query::Query">Query</a>,<br> collector: &C<br>) -> <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a><C::<a class="associatedtype" href="collector/trait.Collector.html#associatedtype.Fruit" title="type tantivy::collector::Collector::Fruit">Fruit</a>></h4></section></summary><div class="docblock"><p>Runs a query on the segment readers wrapped by the searcher.</p> |
| <p>Search works as follows :</p> |
| <p>First the weight object associated with the query is created.</p> |
| <p>Then, the query loops over the segments and for each segment :</p> |
| <ul> |
| <li>setup the collector and informs it that the segment being processed has changed.</li> |
| <li>creates a SegmentCollector for collecting documents associated with the segment</li> |
| <li>creates a <code>Scorer</code> object associated for this segment</li> |
| <li>iterate through the matched documents and push them to the segment collector.</li> |
| </ul> |
| <p>Finally, the Collector merges each of the child collectors into itself for result usability |
| by the caller.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.search_with_executor" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#195-216">source</a><h4 class="code-header">pub fn <a href="#method.search_with_executor" class="fnname">search_with_executor</a><C: <a class="trait" href="collector/trait.Collector.html" title="trait tantivy::collector::Collector">Collector</a>>(<br> &self,<br> query: &dyn <a class="trait" href="query/trait.Query.html" title="trait tantivy::query::Query">Query</a>,<br> collector: &C,<br> executor: &<a class="enum" href="enum.Executor.html" title="enum tantivy::Executor">Executor</a><br>) -> <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a><C::<a class="associatedtype" href="collector/trait.Collector.html#associatedtype.Fruit" title="type tantivy::collector::Collector::Fruit">Fruit</a>></h4></section></summary><div class="docblock"><p>Same as <a href="struct.Searcher.html#method.search"><code>search(...)</code></a> but multithreaded.</p> |
| <p>The current implementation is rather naive : |
| multithreading is by splitting search into as many task |
| as there are segments.</p> |
| <p>It is powerless at making search faster if your index consists in |
| one large segment.</p> |
| <p>Also, keep in my multithreading a single query on several |
| threads will not improve your throughput. It can actually |
| hurt it. It will however, decrease the average response time.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.space_usage" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#219-225">source</a><h4 class="code-header">pub fn <a href="#method.space_usage" class="fnname">space_usage</a>(&self) -> Result<<a class="struct" href="space_usage/struct.SearcherSpaceUsage.html" title="struct tantivy::space_usage::SearcherSpaceUsage">SearcherSpaceUsage</a>></h4></section></summary><div class="docblock"><p>Summarize total space usage of this searcher.</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-Searcher" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#66">source</a><a href="#impl-Clone-for-Searcher" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.Searcher.html" title="struct tantivy::Searcher">Searcher</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/core/searcher.rs.html#66">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.Searcher.html" title="struct tantivy::Searcher">Searcher</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-Searcher" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#278-287">source</a><a href="#impl-Debug-for-Searcher" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.Searcher.html" title="struct tantivy::Searcher">Searcher</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/core/searcher.rs.html#279-286">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-From%3CArc%3CSearcherInner%3E%3E-for-Searcher" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#228-232">source</a><a href="#impl-From%3CArc%3CSearcherInner%3E%3E-for-Searcher" class="anchor"></a><h3 class="code-header">impl From<Arc<SearcherInner>> for <a class="struct" href="struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a></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"><a class="srclink rightside" href="../src/tantivy/core/searcher.rs.html#229-231">source</a><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(inner: Arc<SearcherInner>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</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-Searcher" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Searcher" class="anchor"></a><h3 class="code-header">impl !RefUnwindSafe for <a class="struct" href="struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a></h3></section><section id="impl-Send-for-Searcher" class="impl has-srclink"><a href="#impl-Send-for-Searcher" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a></h3></section><section id="impl-Sync-for-Searcher" class="impl has-srclink"><a href="#impl-Sync-for-Searcher" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a></h3></section><section id="impl-Unpin-for-Searcher" class="impl has-srclink"><a href="#impl-Unpin-for-Searcher" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.Searcher.html" title="struct tantivy::Searcher">Searcher</a></h3></section><section id="impl-UnwindSafe-for-Searcher" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Searcher" class="anchor"></a><h3 class="code-header">impl !UnwindSafe for <a class="struct" href="struct.Searcher.html" title="struct tantivy::Searcher">Searcher</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-Searcher" class="impl has-srclink"><a href="#impl-Any-for-Searcher" 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-Searcher" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Searcher" 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-Searcher" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Searcher" 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-Searcher" class="impl has-srclink"><a class="srclink rightside" href="../src/downcast_rs/lib.rs.html#190">source</a><a href="#impl-Downcast-for-Searcher" 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-Searcher" class="impl has-srclink"><a class="srclink rightside" href="../src/downcast_rs/lib.rs.html#204">source</a><a href="#impl-DowncastSync-for-Searcher" 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-Searcher" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Searcher" 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-1" 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-1" 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-Searcher" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Searcher" 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-Searcher" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#194">source</a><a href="#impl-Pointable-for-Searcher" 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-Searcher" class="impl has-srclink"><a href="#impl-ToOwned-for-Searcher" 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-Searcher" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Searcher" 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-Searcher" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Searcher" 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-Searcher" 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-Searcher" 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-Searcher" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/collector/mod.rs.html#122">source</a><a href="#impl-Fruit-for-Searcher" 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> |
