blob: 3c5e6bf99c11a7975db0bad6826dbe3bd03929ac [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="Search Index"><meta name="keywords" content="rust, rustlang, rust-lang, Index"><title>Index 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">&#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="#">Index</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.builder">builder</a></li><li><a href="#method.create">create</a></li><li><a href="#method.create_in_ram">create_in_ram</a></li><li><a href="#method.directory">directory</a></li><li><a href="#method.directory_mut">directory_mut</a></li><li><a href="#method.exists">exists</a></li><li><a href="#method.load_metas">load_metas</a></li><li><a href="#method.new_segment">new_segment</a></li><li><a href="#method.new_segment_meta">new_segment_meta</a></li><li><a href="#method.open">open</a></li><li><a href="#method.open_or_create">open_or_create</a></li><li><a href="#method.reader">reader</a></li><li><a href="#method.reader_builder">reader_builder</a></li><li><a href="#method.schema">schema</a></li><li><a href="#method.search_executor">search_executor</a></li><li><a href="#method.searchable_segment_ids">searchable_segment_ids</a></li><li><a href="#method.searchable_segment_metas">searchable_segment_metas</a></li><li><a href="#method.searchable_segments">searchable_segments</a></li><li><a href="#method.set_default_multithread_executor">set_default_multithread_executor</a></li><li><a href="#method.set_multithread_executor">set_multithread_executor</a></li><li><a href="#method.set_tokenizers">set_tokenizers</a></li><li><a href="#method.settings">settings</a></li><li><a href="#method.settings_mut">settings_mut</a></li><li><a href="#method.tokenizer_for_field">tokenizer_for_field</a></li><li><a href="#method.tokenizers">tokenizers</a></li><li><a href="#method.validate_checksum">validate_checksum</a></li><li><a href="#method.writer">writer</a></li><li><a href="#method.writer_with_num_threads">writer_with_num_threads</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Index">Clone</a></li><li><a href="#impl-Debug-for-Index">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Index">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Index">Send</a></li><li><a href="#impl-Sync-for-Index">Sync</a></li><li><a href="#impl-Unpin-for-Index">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Index">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Index">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Index">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Index">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-Downcast-for-Index">Downcast</a></li><li><a href="#impl-DowncastSync-for-Index">DowncastSync</a></li><li><a href="#impl-From%3CT%3E-for-Index">From&lt;T&gt;</a></li><li><a href="#impl-Fruit-for-Index">Fruit</a></li><li><a href="#impl-Into%3CU%3E-for-Index">Into&lt;U&gt;</a></li><li><a href="#impl-Pointable-for-Index">Pointable</a></li><li><a href="#impl-ToOwned-for-Index">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Index">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-Index">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-Index">VZip&lt;V&gt;</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="#">Index</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/index.rs.html#285-292">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 Index { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Search Index</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-Index" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#294-664">source</a><a href="#impl-Index" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.builder" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#296-298">source</a><h4 class="code-header">pub fn <a href="#method.builder" class="fnname">builder</a>() -&gt; <a class="struct" href="struct.IndexBuilder.html" title="struct tantivy::IndexBuilder">IndexBuilder</a></h4></section></summary><div class="docblock"><p>Creates a new builder.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.exists" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#302-304">source</a><h4 class="code-header">pub fn <a href="#method.exists" class="fnname">exists</a>(dir: &amp;dyn <a class="trait" href="directory/trait.Directory.html" title="trait tantivy::directory::Directory">Directory</a>) -&gt; Result&lt;bool, <a class="enum" href="directory/error/enum.OpenReadError.html" title="enum tantivy::directory::error::OpenReadError">OpenReadError</a>&gt;</h4></section></summary><div class="docblock"><p>Examines the directory to see if it contains an index.</p>
<p>Effectively, it only checks for the presence of the <code>meta.json</code> file.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.search_executor" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#312-314">source</a><h4 class="code-header">pub fn <a href="#method.search_executor" class="fnname">search_executor</a>(&amp;self) -&gt; &amp;<a class="enum" href="enum.Executor.html" title="enum tantivy::Executor">Executor</a></h4></section></summary><div class="docblock"><p>Accessor to the search executor.</p>
<p>This pool is used by default when calling <code>searcher.search(...)</code>
to perform search on the individual segments.</p>
<p>By default the executor is single thread, and simply runs in the calling thread.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_multithread_executor" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#318-321">source</a><h4 class="code-header">pub fn <a href="#method.set_multithread_executor" class="fnname">set_multithread_executor</a>(&amp;mut self, num_threads: usize) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;()&gt;</h4></section></summary><div class="docblock"><p>Replace the default single thread search executor pool
by a thread pool with a given number of threads.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_default_multithread_executor" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#325-328">source</a><h4 class="code-header">pub fn <a href="#method.set_default_multithread_executor" class="fnname">set_default_multithread_executor</a>(&amp;mut self) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;()&gt;</h4></section></summary><div class="docblock"><p>Replace the default single thread search executor pool
by a thread pool with as many threads as there are CPUs on the system.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.create_in_ram" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#335-337">source</a><h4 class="code-header">pub fn <a href="#method.create_in_ram" class="fnname">create_in_ram</a>(schema: <a class="struct" href="schema/struct.Schema.html" title="struct tantivy::schema::Schema">Schema</a>) -&gt; <a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</a></h4></section></summary><div class="docblock"><p>Creates a new index using the <a href="directory/struct.RamDirectory.html" title="RamDirectory"><code>RamDirectory</code></a>.</p>
<p>The index will be allocated in anonymous memory.
This is useful for indexing small set of documents
for instances like unit test or temporary in memory index.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.open_or_create" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#355-361">source</a><h4 class="code-header">pub fn <a href="#method.open_or_create" class="fnname">open_or_create</a>&lt;T:&nbsp;Into&lt;Box&lt;dyn <a class="trait" href="directory/trait.Directory.html" title="trait tantivy::directory::Directory">Directory</a>&gt;&gt;&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;dir: T,<br>&nbsp;&nbsp;&nbsp;&nbsp;schema: <a class="struct" href="schema/struct.Schema.html" title="struct tantivy::schema::Schema">Schema</a><br>) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</a>&gt;</h4></section></summary><div class="docblock"><p>Opens or creates a new index in the provided directory</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.create" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#380-389">source</a><h4 class="code-header">pub fn <a href="#method.create" class="fnname">create</a>&lt;T:&nbsp;Into&lt;Box&lt;dyn <a class="trait" href="directory/trait.Directory.html" title="trait tantivy::directory::Directory">Directory</a>&gt;&gt;&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;dir: T,<br>&nbsp;&nbsp;&nbsp;&nbsp;schema: <a class="struct" href="schema/struct.Schema.html" title="struct tantivy::schema::Schema">Schema</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;settings: <a class="struct" href="struct.IndexSettings.html" title="struct tantivy::IndexSettings">IndexSettings</a><br>) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</a>&gt;</h4></section></summary><div class="docblock"><p>Creates a new index given an implementation of the trait <code>Directory</code>.</p>
<p>If a directory previously existed, it will be erased.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_tokenizers" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#409-411">source</a><h4 class="code-header">pub fn <a href="#method.set_tokenizers" class="fnname">set_tokenizers</a>(&amp;mut self, tokenizers: <a class="struct" href="tokenizer/struct.TokenizerManager.html" title="struct tantivy::tokenizer::TokenizerManager">TokenizerManager</a>)</h4></section></summary><div class="docblock"><p>Setter for the tokenizer manager.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.tokenizers" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#414-416">source</a><h4 class="code-header">pub fn <a href="#method.tokenizers" class="fnname">tokenizers</a>(&amp;self) -&gt; &amp;<a class="struct" href="tokenizer/struct.TokenizerManager.html" title="struct tantivy::tokenizer::TokenizerManager">TokenizerManager</a></h4></section></summary><div class="docblock"><p>Accessor for the tokenizer manager.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.tokenizer_for_field" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#419-448">source</a><h4 class="code-header">pub fn <a href="#method.tokenizer_for_field" class="fnname">tokenizer_for_field</a>(&amp;self, field: <a class="struct" href="schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="tokenizer/struct.TextAnalyzer.html" title="struct tantivy::tokenizer::TextAnalyzer">TextAnalyzer</a>&gt;</h4></section></summary><div class="docblock"><p>Get the tokenizer associated with a specific field.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.reader" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#453-455">source</a><h4 class="code-header">pub fn <a href="#method.reader" class="fnname">reader</a>(&amp;self) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="struct.IndexReader.html" title="struct tantivy::IndexReader">IndexReader</a>&gt;</h4></section></summary><div class="docblock"><p>Create a default <a href="struct.IndexReader.html" title="IndexReader"><code>IndexReader</code></a> for the given index.</p>
<p>See [<code>Index.reader_builder()</code>].</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.reader_builder" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#461-463">source</a><h4 class="code-header">pub fn <a href="#method.reader_builder" class="fnname">reader_builder</a>(&amp;self) -&gt; <a class="struct" href="struct.IndexReaderBuilder.html" title="struct tantivy::IndexReaderBuilder">IndexReaderBuilder</a></h4></section></summary><div class="docblock"><p>Create a <a href="struct.IndexReader.html" title="IndexReader"><code>IndexReader</code></a> for the given index.</p>
<p>Most project should create at most one reader for a given index.
This method is typically called only once per <code>Index</code> instance.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_segment_meta" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#486-488">source</a><h4 class="code-header">pub fn <a href="#method.new_segment_meta" class="fnname">new_segment_meta</a>(&amp;self, segment_id: <a class="struct" href="struct.SegmentId.html" title="struct tantivy::SegmentId">SegmentId</a>, max_doc: u32) -&gt; <a class="struct" href="struct.SegmentMeta.html" title="struct tantivy::SegmentMeta">SegmentMeta</a></h4></section></summary><div class="docblock"><p>Creates a new segment_meta (Advanced user only).</p>
<p>As long as the <code>SegmentMeta</code> lives, the files associated with the
<code>SegmentMeta</code> are guaranteed to not be garbage collected, regardless of
whether the segment is recorded as part of the index or not.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.open" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#491-498">source</a><h4 class="code-header">pub fn <a href="#method.open" class="fnname">open</a>&lt;T:&nbsp;Into&lt;Box&lt;dyn <a class="trait" href="directory/trait.Directory.html" title="trait tantivy::directory::Directory">Directory</a>&gt;&gt;&gt;(directory: T) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</a>&gt;</h4></section></summary><div class="docblock"><p>Open the index using the provided directory</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.load_metas" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#501-503">source</a><h4 class="code-header">pub fn <a href="#method.load_metas" class="fnname">load_metas</a>(&amp;self) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="struct.IndexMeta.html" title="struct tantivy::IndexMeta">IndexMeta</a>&gt;</h4></section></summary><div class="docblock"><p>Reads the index meta file from the directory.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.writer_with_num_threads" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#524-550">source</a><h4 class="code-header">pub fn <a href="#method.writer_with_num_threads" class="fnname">writer_with_num_threads</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;num_threads: usize,<br>&nbsp;&nbsp;&nbsp;&nbsp;overall_memory_arena_in_bytes: usize<br>) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="struct.IndexWriter.html" title="struct tantivy::IndexWriter">IndexWriter</a>&gt;</h4></section></summary><div class="docblock"><p>Open a new index writer. Attempts to acquire a lockfile.</p>
<p>The lockfile should be deleted on drop, but it is possible
that due to a panic or other error, a stale lockfile will be
left in the index directory. If you are sure that no other
<code>IndexWriter</code> on the system is accessing the index directory,
it is safe to manually delete the lockfile.</p>
<ul>
<li>
<p><code>num_threads</code> defines the number of indexing workers that
should work at the same time.</p>
</li>
<li>
<p><code>overall_memory_arena_in_bytes</code> sets the amount of memory
allocated for all indexing thread.
Each thread will receive a budget of <code>overall_memory_arena_in_bytes / num_threads</code>.</p>
</li>
</ul>
<h5 id="errors"><a href="#errors">Errors</a></h5>
<p>If the lockfile already exists, returns <code>Error::DirectoryLockBusy</code> or an <code>Error::IoError</code>.
If the memory arena per thread is too small or too big, returns
<code>TantivyError::InvalidArgument</code></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.writer" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#572-579">source</a><h4 class="code-header">pub fn <a href="#method.writer" class="fnname">writer</a>(&amp;self, memory_arena_num_bytes: usize) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;<a class="struct" href="struct.IndexWriter.html" title="struct tantivy::IndexWriter">IndexWriter</a>&gt;</h4></section></summary><div class="docblock"><p>Creates a multithreaded writer</p>
<p>Tantivy will automatically define the number of threads to use, but
no more than 8 threads.
<code>overall_memory_arena_in_bytes</code> is the total target memory usage that will be split
between a given number of threads.</p>
<h5 id="errors-1"><a href="#errors-1">Errors</a></h5>
<p>If the lockfile already exists, returns <code>Error::FileAlreadyExists</code>.
If the memory arena per thread is too small or too big, returns
<code>TantivyError::InvalidArgument</code></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.settings" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#582-584">source</a><h4 class="code-header">pub fn <a href="#method.settings" class="fnname">settings</a>(&amp;self) -&gt; &amp;<a class="struct" href="struct.IndexSettings.html" title="struct tantivy::IndexSettings">IndexSettings</a></h4></section></summary><div class="docblock"><p>Accessor to the index settings</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.settings_mut" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#587-589">source</a><h4 class="code-header">pub fn <a href="#method.settings_mut" class="fnname">settings_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="struct.IndexSettings.html" title="struct tantivy::IndexSettings">IndexSettings</a></h4></section></summary><div class="docblock"><p>Accessor to the index settings</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/index.rs.html#594-596">source</a><h4 class="code-header">pub fn <a href="#method.schema" class="fnname">schema</a>(&amp;self) -&gt; <a class="struct" href="schema/struct.Schema.html" title="struct tantivy::schema::Schema">Schema</a></h4></section></summary><div class="docblock"><p>Accessor to the index schema</p>
<p>The schema is actually cloned.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.searchable_segments" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#599-605">source</a><h4 class="code-header">pub fn <a href="#method.searchable_segments" class="fnname">searchable_segments</a>(&amp;self) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;Vec&lt;<a class="struct" href="struct.Segment.html" title="struct tantivy::Segment">Segment</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Returns the list of segments that are searchable</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_segment" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#613-618">source</a><h4 class="code-header">pub fn <a href="#method.new_segment" class="fnname">new_segment</a>(&amp;self) -&gt; <a class="struct" href="struct.Segment.html" title="struct tantivy::Segment">Segment</a></h4></section></summary><div class="docblock"><p>Creates a new segment.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.directory" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#621-623">source</a><h4 class="code-header">pub fn <a href="#method.directory" class="fnname">directory</a>(&amp;self) -&gt; &amp;<a class="struct" href="directory/struct.ManagedDirectory.html" title="struct tantivy::directory::ManagedDirectory">ManagedDirectory</a></h4></section></summary><div class="docblock"><p>Return a reference to the index directory.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.directory_mut" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#626-628">source</a><h4 class="code-header">pub fn <a href="#method.directory_mut" class="fnname">directory_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="directory/struct.ManagedDirectory.html" title="struct tantivy::directory::ManagedDirectory">ManagedDirectory</a></h4></section></summary><div class="docblock"><p>Return a mutable reference to the index directory.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.searchable_segment_metas" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#632-634">source</a><h4 class="code-header">pub fn <a href="#method.searchable_segment_metas" class="fnname">searchable_segment_metas</a>(&amp;self) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;Vec&lt;<a class="struct" href="struct.SegmentMeta.html" title="struct tantivy::SegmentMeta">SegmentMeta</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Reads the meta.json and returns the list of
<code>SegmentMeta</code> from the last commit.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.searchable_segment_ids" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#637-643">source</a><h4 class="code-header">pub fn <a href="#method.searchable_segment_ids" class="fnname">searchable_segment_ids</a>(&amp;self) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;Vec&lt;<a class="struct" href="struct.SegmentId.html" title="struct tantivy::SegmentId">SegmentId</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Returns the list of segment ids that are searchable.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.validate_checksum" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#646-663">source</a><h4 class="code-header">pub fn <a href="#method.validate_checksum" class="fnname">validate_checksum</a>(&amp;self) -&gt; <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a>&lt;HashSet&lt;PathBuf&gt;&gt;</h4></section></summary><div class="docblock"><p>Returns the set of corrupted files</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-Index" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#284">source</a><a href="#impl-Clone-for-Index" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</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/index.rs.html#284">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</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>(&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-Index" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/core/index.rs.html#666-670">source</a><a href="#impl-Debug-for-Index" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</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/index.rs.html#667-669">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></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-Index" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Index" class="anchor"></a><h3 class="code-header">impl !RefUnwindSafe for <a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</a></h3></section><section id="impl-Send-for-Index" class="impl has-srclink"><a href="#impl-Send-for-Index" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</a></h3></section><section id="impl-Sync-for-Index" class="impl has-srclink"><a href="#impl-Sync-for-Index" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</a></h3></section><section id="impl-Unpin-for-Index" class="impl has-srclink"><a href="#impl-Unpin-for-Index" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</a></h3></section><section id="impl-UnwindSafe-for-Index" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Index" class="anchor"></a><h3 class="code-header">impl !UnwindSafe for <a class="struct" href="struct.Index.html" title="struct tantivy::Index">Index</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-Index" class="impl has-srclink"><a href="#impl-Any-for-Index" 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-Index" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Index" 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-Index" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Index" 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-Index" class="impl has-srclink"><a class="srclink rightside" href="../src/downcast_rs/lib.rs.html#190">source</a><a href="#impl-Downcast-for-Index" 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-Index" class="impl has-srclink"><a class="srclink rightside" href="../src/downcast_rs/lib.rs.html#204">source</a><a href="#impl-DowncastSync-for-Index" 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-Index" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Index" 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-Index" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Index" 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-Index" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#194">source</a><a href="#impl-Pointable-for-Index" 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-Index" class="impl has-srclink"><a href="#impl-ToOwned-for-Index" 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-Index" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Index" 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-Index" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Index" 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-Index" 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-Index" 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-Index" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/collector/mod.rs.html#122">source</a><a href="#impl-Fruit-for-Index" 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>