| <!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="Entry point to access all of the datastructures of the `Segment`"><meta name="keywords" content="rust, rustlang, rust-lang, SegmentReader"><title>SegmentReader 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="#">SegmentReader</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.alive_bitset">alive_bitset</a></li><li><a href="#method.delete_opstamp">delete_opstamp</a></li><li><a href="#method.doc_ids_alive">doc_ids_alive</a></li><li><a href="#method.facet_reader">facet_reader</a></li><li><a href="#method.fast_fields">fast_fields</a></li><li><a href="#method.get_fieldnorms_reader">get_fieldnorms_reader</a></li><li><a href="#method.get_store_reader">get_store_reader</a></li><li><a href="#method.has_deletes">has_deletes</a></li><li><a href="#method.inverted_index">inverted_index</a></li><li><a href="#method.is_deleted">is_deleted</a></li><li><a href="#method.max_doc">max_doc</a></li><li><a href="#method.num_deleted_docs">num_deleted_docs</a></li><li><a href="#method.num_docs">num_docs</a></li><li><a href="#method.open">open</a></li><li><a href="#method.open_with_custom_alive_set">open_with_custom_alive_set</a></li><li><a href="#method.schema">schema</a></li><li><a href="#method.segment_id">segment_id</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-SegmentReader">Clone</a></li><li><a href="#impl-Debug-for-SegmentReader">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-SegmentReader">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-SegmentReader">Send</a></li><li><a href="#impl-Sync-for-SegmentReader">Sync</a></li><li><a href="#impl-Unpin-for-SegmentReader">Unpin</a></li><li><a href="#impl-UnwindSafe-for-SegmentReader">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-SegmentReader">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-SegmentReader">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-SegmentReader">BorrowMut<T></a></li><li><a href="#impl-Downcast-for-SegmentReader">Downcast</a></li><li><a href="#impl-DowncastSync-for-SegmentReader">DowncastSync</a></li><li><a href="#impl-From%3CT%3E-for-SegmentReader">From<T></a></li><li><a href="#impl-Fruit-for-SegmentReader">Fruit</a></li><li><a href="#impl-Into%3CU%3E-for-SegmentReader">Into<U></a></li><li><a href="#impl-Pointable-for-SegmentReader">Pointable</a></li><li><a href="#impl-ToOwned-for-SegmentReader">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-SegmentReader">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-SegmentReader">TryInto<U></a></li><li><a href="#impl-VZip%3CV%3E-for-SegmentReader">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="#">SegmentReader</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/segment_reader.rs.html#29-47">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 SegmentReader { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Entry point to access all of the datastructures of the <code>Segment</code></p> |
| <ul> |
| <li>term dictionary</li> |
| <li>postings</li> |
| <li>store</li> |
| <li>fast field readers</li> |
| <li>field norm reader</li> |
| </ul> |
| <p>The segment reader has a very low memory footprint, |
| as close to all of the memory data is mmapped.</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-SegmentReader" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#49-337">source</a><a href="#impl-SegmentReader" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max_doc" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#52-54">source</a><h4 class="code-header">pub fn <a href="#method.max_doc" class="fnname">max_doc</a>(&self) -> <a class="type" href="type.DocId.html" title="type tantivy::DocId">DocId</a></h4></section></summary><div class="docblock"><p>Returns the highest document id ever attributed in |
| this segment + 1.</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/segment_reader.rs.html#58-60">source</a><h4 class="code-header">pub fn <a href="#method.num_docs" class="fnname">num_docs</a>(&self) -> <a class="type" href="type.DocId.html" title="type tantivy::DocId">DocId</a></h4></section></summary><div class="docblock"><p>Returns the number of alive documents. |
| Deleted documents are not counted.</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/segment_reader.rs.html#63-65">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>Returns the schema of the index this segment belongs to.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.num_deleted_docs" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#69-71">source</a><h4 class="code-header">pub fn <a href="#method.num_deleted_docs" class="fnname">num_deleted_docs</a>(&self) -> <a class="type" href="type.DocId.html" title="type tantivy::DocId">DocId</a></h4></section></summary><div class="docblock"><p>Return the number of documents that have been |
| deleted in the segment.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.has_deletes" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#74-76">source</a><h4 class="code-header">pub fn <a href="#method.has_deletes" class="fnname">has_deletes</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Returns true if some of the documents of the segment have been deleted.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fast_fields" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#88-90">source</a><h4 class="code-header">pub fn <a href="#method.fast_fields" class="fnname">fast_fields</a>(&self) -> &<a class="struct" href="fastfield/struct.FastFieldReaders.html" title="struct tantivy::fastfield::FastFieldReaders">FastFieldReaders</a></h4></section></summary><div class="docblock"><p>Accessor to a segment’s fast field reader given a field.</p> |
| <p>Returns the u64 fast value reader if the field |
| is a u64 field indexed as “fast”.</p> |
| <p>Return a FastFieldNotAvailableError if the field is not |
| declared as a fast field in the schema.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>May panic if the index is corrupted.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.facet_reader" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#93-111">source</a><h4 class="code-header">pub fn <a href="#method.facet_reader" class="fnname">facet_reader</a>(&self, field: <a class="struct" href="schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>) -> <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a><<a class="struct" href="fastfield/struct.FacetReader.html" title="struct tantivy::fastfield::FacetReader">FacetReader</a>></h4></section></summary><div class="docblock"><p>Accessor to the <code>FacetReader</code> associated with a given <code>Field</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_fieldnorms_reader" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#120-129">source</a><h4 class="code-header">pub fn <a href="#method.get_fieldnorms_reader" class="fnname">get_fieldnorms_reader</a>(&self, field: <a class="struct" href="schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>) -> <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a><<a class="struct" href="fieldnorm/struct.FieldNormReader.html" title="struct tantivy::fieldnorm::FieldNormReader">FieldNormReader</a>></h4></section></summary><div class="docblock"><p>Accessor to the segment’s <code>Field norms</code>’s reader.</p> |
| <p>Field norms are the length (in tokens) of the fields. |
| It is used in the computation of the <a href="https://fulmicoton.gitbooks.io/tantivy-doc/content/tfidf.html">TfIdf</a>.</p> |
| <p>They are simply stored as a fast field, serialized in |
| the <code>.fieldnorm</code> file of the segment.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_store_reader" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#137-139">source</a><h4 class="code-header">pub fn <a href="#method.get_store_reader" class="fnname">get_store_reader</a>(&self, cache_size: usize) -> Result<<a class="struct" href="store/struct.StoreReader.html" title="struct tantivy::store::StoreReader">StoreReader</a>></h4></section></summary><div class="docblock"><p>Accessor to the segment’s <code>StoreReader</code>.</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/segment_reader.rs.html#142-144">source</a><h4 class="code-header">pub fn <a href="#method.open" class="fnname">open</a>(segment: &<a class="struct" href="struct.Segment.html" title="struct tantivy::Segment">Segment</a>) -> <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a><<a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a>></h4></section></summary><div class="docblock"><p>Open a new segment for reading.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.open_with_custom_alive_set" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#147-209">source</a><h4 class="code-header">pub fn <a href="#method.open_with_custom_alive_set" class="fnname">open_with_custom_alive_set</a>(<br> segment: &<a class="struct" href="struct.Segment.html" title="struct tantivy::Segment">Segment</a>,<br> custom_bitset: Option<<a class="struct" href="fastfield/struct.AliveBitSet.html" title="struct tantivy::fastfield::AliveBitSet">AliveBitSet</a>><br>) -> <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a><<a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a>></h4></section></summary><div class="docblock"><p>Open a new segment for reading.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.inverted_index" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#223-287">source</a><h4 class="code-header">pub fn <a href="#method.inverted_index" class="fnname">inverted_index</a>(&self, field: <a class="struct" href="schema/struct.Field.html" title="struct tantivy::schema::Field">Field</a>) -> <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a><Arc<<a class="struct" href="struct.InvertedIndexReader.html" title="struct tantivy::InvertedIndexReader">InvertedIndexReader</a>>></h4></section></summary><div class="docblock"><p>Returns a field reader associated with the field given in argument. |
| If the field was not present in the index during indexing time, |
| the InvertedIndexReader is empty.</p> |
| <p>The field reader is in charge of iterating through the |
| term dictionary associated with a specific field, |
| and opening the posting list associated with any term.</p> |
| <p>If the field is not marked as index, a warning is logged and an empty <code>InvertedIndexReader</code> |
| is returned. |
| Similarly, if the field is marked as indexed but no term has been indexed for the given |
| index, an empty <code>InvertedIndexReader</code> is returned (but no warning is logged).</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.segment_id" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#290-292">source</a><h4 class="code-header">pub fn <a href="#method.segment_id" class="fnname">segment_id</a>(&self) -> <a class="struct" href="struct.SegmentId.html" title="struct tantivy::SegmentId">SegmentId</a></h4></section></summary><div class="docblock"><p>Returns the segment id</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.delete_opstamp" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#295-297">source</a><h4 class="code-header">pub fn <a href="#method.delete_opstamp" class="fnname">delete_opstamp</a>(&self) -> Option<<a class="type" href="type.Opstamp.html" title="type tantivy::Opstamp">Opstamp</a>></h4></section></summary><div class="docblock"><p>Returns the delete opstamp</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.alive_bitset" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#300-302">source</a><h4 class="code-header">pub fn <a href="#method.alive_bitset" class="fnname">alive_bitset</a>(&self) -> Option<&<a class="struct" href="fastfield/struct.AliveBitSet.html" title="struct tantivy::fastfield::AliveBitSet">AliveBitSet</a>></h4></section></summary><div class="docblock"><p>Returns the bitset representing the alive <code>DocId</code>s.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_deleted" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#306-310">source</a><h4 class="code-header">pub fn <a href="#method.is_deleted" class="fnname">is_deleted</a>(&self, doc: <a class="type" href="type.DocId.html" title="type tantivy::DocId">DocId</a>) -> bool</h4></section></summary><div class="docblock"><p>Returns true if the <code>doc</code> is marked |
| as deleted.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.doc_ids_alive" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#313-319">source</a><h4 class="code-header">pub fn <a href="#method.doc_ids_alive" class="fnname">doc_ids_alive</a>(&self) -> Box<dyn Iterator<Item = <a class="type" href="type.DocId.html" title="type tantivy::DocId">DocId</a>> + '_></h4></section></summary><div class="docblock"><p>Returns an iterator that will iterate over the alive document ids</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/segment_reader.rs.html#322-336">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.SegmentSpaceUsage.html" title="struct tantivy::space_usage::SegmentSpaceUsage">SegmentSpaceUsage</a>></h4></section></summary><div class="docblock"><p>Summarize total space usage of this segment.</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-SegmentReader" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#28">source</a><a href="#impl-Clone-for-SegmentReader" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</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/segment_reader.rs.html#28">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.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</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-SegmentReader" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/core/segment_reader.rs.html#354-358">source</a><a href="#impl-Debug-for-SegmentReader" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</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/segment_reader.rs.html#355-357">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></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-SegmentReader" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-SegmentReader" class="anchor"></a><h3 class="code-header">impl !RefUnwindSafe for <a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a></h3></section><section id="impl-Send-for-SegmentReader" class="impl has-srclink"><a href="#impl-Send-for-SegmentReader" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a></h3></section><section id="impl-Sync-for-SegmentReader" class="impl has-srclink"><a href="#impl-Sync-for-SegmentReader" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a></h3></section><section id="impl-Unpin-for-SegmentReader" class="impl has-srclink"><a href="#impl-Unpin-for-SegmentReader" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a></h3></section><section id="impl-UnwindSafe-for-SegmentReader" class="impl has-srclink"><a href="#impl-UnwindSafe-for-SegmentReader" class="anchor"></a><h3 class="code-header">impl !UnwindSafe for <a class="struct" href="struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</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-SegmentReader" class="impl has-srclink"><a href="#impl-Any-for-SegmentReader" 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-SegmentReader" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-SegmentReader" 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-SegmentReader" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-SegmentReader" 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-SegmentReader" class="impl has-srclink"><a class="srclink rightside" href="../src/downcast_rs/lib.rs.html#190">source</a><a href="#impl-Downcast-for-SegmentReader" 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-SegmentReader" class="impl has-srclink"><a class="srclink rightside" href="../src/downcast_rs/lib.rs.html#204">source</a><a href="#impl-DowncastSync-for-SegmentReader" 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-SegmentReader" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-SegmentReader" 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" 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) -> 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-SegmentReader" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-SegmentReader" 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-SegmentReader" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#194">source</a><a href="#impl-Pointable-for-SegmentReader" 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-SegmentReader" class="impl has-srclink"><a href="#impl-ToOwned-for-SegmentReader" 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-SegmentReader" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-SegmentReader" 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-SegmentReader" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-SegmentReader" 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-SegmentReader" 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-SegmentReader" 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-SegmentReader" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/collector/mod.rs.html#122">source</a><a href="#impl-Fruit-for-SegmentReader" 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> |
