Struct tantivy::InvertedIndexReader [−][src]
pub struct InvertedIndexReader { /* fields omitted */ }
The inverted index reader is in charge of accessing the inverted index associated to a specific field.
Note
It is safe to delete the segment associated to
an InvertedIndexReader
. As long as it is open,
the ReadOnlySource
it is relying on should
stay available.
InvertedIndexReader
are created by calling
the SegmentReader
's [.inverted_index(...)
] method
Methods
impl InvertedIndexReader
[src]
impl InvertedIndexReader
pub fn empty(field_type: &FieldType) -> InvertedIndexReader
[src]
pub fn empty(field_type: &FieldType) -> InvertedIndexReader
Creates an empty InvertedIndexReader
object, which
contains no terms at all.
pub fn get_term_info(&self, term: &Term) -> Option<TermInfo>
[src]
pub fn get_term_info(&self, term: &Term) -> Option<TermInfo>
Returns the term info associated with the term.
pub fn terms(&self) -> &TermDictionary
[src]
pub fn terms(&self) -> &TermDictionary
Return the term dictionary datastructure.
pub fn reset_block_postings_from_terminfo(
&self,
term_info: &TermInfo,
block_postings: &mut BlockSegmentPostings
)
[src]
pub fn reset_block_postings_from_terminfo(
&self,
term_info: &TermInfo,
block_postings: &mut BlockSegmentPostings
)
Resets the block segment to another position of the postings file.
This is useful for enumerating through a list of terms,
and consuming the associated posting lists while avoiding
reallocating a BlockSegmentPostings
.
Warning
This does not reset the positions list.
pub fn read_block_postings(
&self,
term: &Term,
option: IndexRecordOption
) -> Option<BlockSegmentPostings>
[src]
pub fn read_block_postings(
&self,
term: &Term,
option: IndexRecordOption
) -> Option<BlockSegmentPostings>
Returns a block postings given a Term
.
This method is for an advanced usage only.
Most user should prefer using read_postings
instead.
pub fn read_block_postings_from_terminfo(
&self,
term_info: &TermInfo,
requested_option: IndexRecordOption
) -> BlockSegmentPostings
[src]
pub fn read_block_postings_from_terminfo(
&self,
term_info: &TermInfo,
requested_option: IndexRecordOption
) -> BlockSegmentPostings
Returns a block postings given a term_info
.
This method is for an advanced usage only.
Most user should prefer using read_postings
instead.
pub fn read_postings_from_terminfo(
&self,
term_info: &TermInfo,
option: IndexRecordOption
) -> SegmentPostings
[src]
pub fn read_postings_from_terminfo(
&self,
term_info: &TermInfo,
option: IndexRecordOption
) -> SegmentPostings
Returns a posting object given a term_info
.
This method is for an advanced usage only.
Most user should prefer using read_postings
instead.
pub fn total_num_tokens(&self) -> u64
[src]
pub fn total_num_tokens(&self) -> u64
Returns the total number of tokens recorded for all documents (including deleted documents).
pub fn read_postings(
&self,
term: &Term,
option: IndexRecordOption
) -> Option<SegmentPostings>
[src]
pub fn read_postings(
&self,
term: &Term,
option: IndexRecordOption
) -> Option<SegmentPostings>
Returns the segment postings associated with the term, and with the given option,
or None
if the term has never been encountered and indexed.
If the field was not indexed with the indexing options that cover
the requested options, the returned SegmentPostings
the method does not fail
and returns a SegmentPostings
with as much information as possible.
For instance, requesting IndexRecordOption::Freq
for a
TextIndexingOptions
that does not index position will return a SegmentPostings
with DocId
s and frequencies.
pub fn doc_freq(&self, term: &Term) -> u32
[src]
pub fn doc_freq(&self, term: &Term) -> u32
Returns the number of documents containing the term.
Auto Trait Implementations
impl Send for InvertedIndexReader
impl Send for InvertedIndexReader
impl Sync for InvertedIndexReader
impl Sync for InvertedIndexReader