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.

Implementations

impl BlockSegmentPostings

pub fn block_max_score(
    &mut self,
    fieldnorm_reader: &FieldNormReader,
    bm25_weight: &BM25Weight
) -> Score

Returns the block_max_score for the current block. It does not require the block to be loaded. For instance, it is ok to call this method after having called .shallow_advance(..).

See TermScorer::block_max_score(..) for more information.

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.

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 block_len(&self) -> usize

Returns the length of the current block.

All blocks have a length of NUM_DOCS_PER_BLOCK, except the last block that may have a length of any number between 1 and NUM_DOCS_PER_BLOCK - 1

pub fn seek(&mut self, target_doc: DocId)

Position on a block that may contains target_doc.

If all docs are smaller than target, the block loaded may be empty, or be the last an incomplete VInt block.

pub fn advance(&mut self)

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 Clone for BlockSegmentPostings

fn clone(&self) -> BlockSegmentPostings

Returns a copy of the value.

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

Performs copy-assignment from source.