Struct tantivy::postings::BlockSegmentPostings

pub struct BlockSegmentPostings { /* fields omitted */ }

BlockSegmentPostings is a cursor iterating over blocks of documents.

Warning

While it is useful for some very specific high-performance use cases, you should prefer using SegmentPostings for most usage.

Methods

impl BlockSegmentPostings

pub fn doc_freq(&self) -> usize

Returns the document frequency associated to this block postings.

This doc_freq is simply the sum of the length of all of the blocks length, and it does not take in account deleted documents.

pub fn docs(&self) -> &[DocId]

Returns the array of docs in the current block.

Before the first call to .advance(), the block returned by .docs() is empty.

pub fn doc(&self, idx: usize) -> u32

Return the document at index idx of the block.

pub fn freqs(&self) -> &[u32]

Return the array of term freq in the block.

pub fn freq(&self, idx: usize) -> u32

Return the frequency at index idx of the block.

pub fn skip_to(&mut self, target_doc: DocId) -> BlockSegmentPostingsSkipResult

position on a block that may contains doc_id. Always advance the current block.

Returns true if a block that has an element greater or equal to the target is found. Returning true does not guarantee that the smallest element of the block is smaller than the target. It only guarantees that the last element is greater or equal.

Returns false iff all of the document remaining are smaller than doc_id. In that case, all of these document are consumed.

pub fn advance(&mut self) -> bool

Advance to the next block.

Returns false iff there was no remaining blocks.

pub fn empty() -> BlockSegmentPostings

Returns an empty segment postings object

Trait Implementations

impl<'b> Streamer<'b> for BlockSegmentPostings

type Item = &'b [DocId]

The type of the item emitted by this stream.

fn next(&'b mut self) -> Option<&'b [DocId]>

Emits the next element in this stream, or None to indicate the stream has been exhausted.