Struct TermCursor 

pub struct TermCursor<'segment> {
    pub stream: TermStream<'segment>,
    pub df: Df,
    pub scorer: TermScorer,
    pub upper_bound: f64,
}

One query term prepared for pruning within one segment.

The cursor is a view over the sealed streams, not a copy of them. It holds no entry array: advance and seek walk block metadata and decode only the blocks the traversal actually lands in.

Fields

stream: TermStream<'segment>

The merged sealed postings for this term across the weighted fields.

df: Df

Store-wide document frequency.

scorer: TermScorer

This term’s hoisted scoring constants.

Built once per (term, segment) so the inner loops never recompute idf or avgdl. See crate::fts::bm25::TermScorer.

upper_bound: f64

Largest contribution this term can make to any document.

Implementations

impl TermCursor<'_>

pub fn current(&self) -> Option<u32>

Returns the row at the cursor, or None when exhausted.

pub fn current_tf(&mut self) -> Option<u32>

Returns the merged term frequency at the cursor.

The first ask against a block pays that block’s tf decode; rows that are skipped rather than scored never pay it.

pub fn advance(&mut self)

Advances one merged posting.

pub fn reset(&mut self)

Rewinds to the first merged posting.

pub fn seek(&mut self, row: u32)

Advances to the first row at or after row.

Skip keys ascend, so the first block that can hold row is a binary search over metadata rows; the blocks between are never decoded.

pub fn current_block_max(&self) -> f64

Returns the bound of the block the cursor currently sits in.

Read from the stored impact pairs and evaluated against this query’s live statistics; see crate::fts::sealed.

pub fn exhausted(&self) -> bool

Returns true when the cursor has passed the last entry.

Trait Implementations

impl<'segment> Clone for TermCursor<'segment>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'segment> Debug for TermCursor<'segment>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.