Struct tantivy::InvertedIndexReader [−][src]
pub struct InvertedIndexReader { /* fields omitted */ }
Expand description
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 FileSlice
it is relying on should
stay available.
InvertedIndexReader
are created by calling
the SegmentReader
’s [.inverted_index(...)
] method
Implementations
Creates an empty InvertedIndexReader
object, which
contains no terms at all.
Returns the term info associated with the term.
Return the term dictionary datastructure.
pub fn reset_block_postings_from_terminfo(
&self,
term_info: &TermInfo,
block_postings: &mut BlockSegmentPostings
) -> Result<()>
[src]
pub fn reset_block_postings_from_terminfo(
&self,
term_info: &TermInfo,
block_postings: &mut BlockSegmentPostings
) -> Result<()>
[src]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
) -> Result<Option<BlockSegmentPostings>>
[src]
pub fn read_block_postings(
&self,
term: &Term,
option: IndexRecordOption
) -> Result<Option<BlockSegmentPostings>>
[src]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
) -> Result<BlockSegmentPostings>
[src]
pub fn read_block_postings_from_terminfo(
&self,
term_info: &TermInfo,
requested_option: IndexRecordOption
) -> Result<BlockSegmentPostings>
[src]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
) -> Result<SegmentPostings>
[src]
pub fn read_postings_from_terminfo(
&self,
term_info: &TermInfo,
option: IndexRecordOption
) -> Result<SegmentPostings>
[src]Returns a posting object given a term_info
.
This method is for an advanced usage only.
Most user should prefer using read_postings
instead.
Returns the total number of tokens recorded for all documents (including deleted documents).
pub fn read_postings(
&self,
term: &Term,
option: IndexRecordOption
) -> Result<Option<SegmentPostings>>
[src]
pub fn read_postings(
&self,
term: &Term,
option: IndexRecordOption
) -> Result<Option<SegmentPostings>>
[src]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.
Auto Trait Implementations
impl !RefUnwindSafe for InvertedIndexReader
impl Send for InvertedIndexReader
impl Sync for InvertedIndexReader
impl Unpin for InvertedIndexReader
impl !UnwindSafe for InvertedIndexReader
Blanket Implementations
Mutably borrows from an owned value. Read more
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
pub fn vzip(self) -> V