Struct tantivy::postings::SegmentPostings

pub struct SegmentPostings { /* private fields */ }

SegmentPostings represents the inverted list or postings associated with a term in a Segment.

As we iterate through the SegmentPostings, the frequencies are optionally decoded. Positions on the other hand, are optionally entirely decoded upfront.

Implementations

impl SegmentPostings

pub fn empty() -> Self

Returns an empty segment postings object

pub fn doc_freq_given_deletes(&self, alive_bitset: &AliveBitSet) -> u32

Compute the number of non-deleted documents.

This method will clone and scan through the posting lists. (this is a rather expensive operation).

pub fn doc_freq(&self) -> u32

Returns the overall number of documents in the block postings. It does not take in account whether documents are deleted or not.

Trait Implementations

impl Clone for SegmentPostings

fn clone(&self) -> SegmentPostings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DocSet for SegmentPostings

fn doc(&self) -> DocId

Return the current document’s DocId.

fn advance(&mut self) -> DocId

Goes to the next element.

fn seek(&mut self, target: DocId) -> DocId

Advances the DocSet forward until reaching the target, or going to the lowest DocId greater than the target.

fn size_hint(&self) -> u32

Returns a best-effort hint of the length of the docset.

fn fill_buffer(&mut self, buffer: &mut [DocId; 64]) -> usize

Fills a given mutable buffer with the next doc ids from the DocSet

fn count(&mut self, alive_bitset: &AliveBitSet) -> u32

Returns the number documents matching. Calling this method consumes the DocSet.

fn count_including_deleted(&mut self) -> u32

Returns the count of documents, deleted or not. Calling this method consumes the DocSet.

impl HasLen for SegmentPostings

fn len(&self) -> usize

Return length

fn is_empty(&self) -> bool

Returns true iff empty.

impl Postings for SegmentPostings

fn term_freq(&self) -> u32

Returns the frequency associated with the current document. If the schema is set up so that no frequency have been encoded, this method should always return 1.

Panics

Will panics if called without having called advance before.

fn positions_with_offset(&mut self, offset: u32, output: &mut Vec<u32>)

Returns the positions offsetted with a given value. The output vector will be resized to the term_freq.

fn positions(&mut self, output: &mut Vec<u32>)

Returns the positions of the term in the given document. The output vector will be resized to the term_freq.