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 from_block_postings(
    segment_block_postings: BlockSegmentPostings,
    delete_bitset: DeleteBitSet,
    positions_stream_opt: Option<CompressedIntStream>
) -> SegmentPostings

Reads a Segment postings from an &[u8]

• len - number of document in the posting lists.
• data - data array. The complete data is not necessarily used.
• freq_handler - the freq handler is in charge of decoding frequencies and/or positions

pub fn empty() -> SegmentPostings

Returns an empty segment postings object

Trait Implementations

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 size_hint(&self) -> u32

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

fn doc(&self) -> DocId

Return the current document's DocId.

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 next(&mut self) -> Option<DocId>

Advances the cursor to the next document None is returned if the iterator has DocSet has already been entirely consumed.

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 term frequency

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

fn positions(&self) -> &[u32]

Returns the list of positions of the term, expressed as a list of token ordinals.