Struct tantivy::postings::SegmentPostings

pub struct SegmentPostings { /* fields omitted */ }

SegmentPostings represents the inverted list or postings associated to 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.

Methods

impl SegmentPostings

pub fn empty() -> Self

Returns an empty segment postings object

pub fn create_from_docs(docs: &[u32]) -> SegmentPostings

Creates a segment postings object with the given documents and no frequency encoded.

This method is mostly useful for unit tests.

It serializes the doc ids using tantivy's codec and returns a SegmentPostings object that embeds a buffer with the serialized data.

Trait Implementations

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 to 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 offseted 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.

impl DocSet for SegmentPostings

fn advance(&mut self) -> bool

Goes to the next element. .advance(...) needs to be called a first time to point to the correct element.

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

After skipping, position the iterator in such a way that .doc() will return a value greater than or equal to target.

fn doc(&self) -> DocId

Return the current document's DocId.

Panics

Will panics if called without having called advance before.

fn size_hint(&self) -> u32

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

fn append_to_bitset(&mut self, bitset: &mut BitSet)

Appends all docs to a bitset.

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

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

fn count(&mut self, delete_bitset: &DeleteBitSet) -> 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.