Struct TopKCollector 

pub struct TopKCollector { /* private fields */ }

Collector for top-k results

Implementations

impl TopKCollector

pub fn new(k: usize) -> Self

pub fn with_positions(k: usize) -> Self

Create a collector that also collects positions

pub fn total_seen(&self) -> u32

Get the total number of documents seen (scored) by this collector

pub fn is_full(&self) -> bool

Whether the heap already holds k results.

pub fn into_sorted_results(self) -> Vec<SearchResult>

pub fn into_results_with_count(self) -> (Vec<SearchResult>, u32)

Consume collector and return (sorted_results, total_seen)

Trait Implementations

impl Collector for TopKCollector

fn ranked_count_limit(&self) -> Option<usize>

Opt into exact counting separately from ranked collection. A finite limit promises that retaining this many highest ranked matches is enough. Custom collectors keep exhaustive callbacks by default.

fn collect_omitted_count(&mut self, count: u64)

Account for exact matches omitted by the ranked path. Called only after ranked_count_limit opts in; must preserve every count/total_seen field.

fn supports_score_blocks(&self) -> bool

Opt into bounded score blocks when positions and per-hit deadline checks are unnecessary. Custom collectors retain per-document calls. Tuple children opting in permit calls to be grouped by collector.

fn collect_score_block(&mut self, base: DocId, scores: &[Score; 64], bits: u64)

Collect set bits in increasing document order, with scores[i] for document base + i. Set bits must address valid document IDs. The driver calls this only after supports_score_blocks returns true.

fn collect( &mut self, doc_id: DocId, score: Score, positions: &[(u32, Vec<ScoredPosition>)], )

Called for each matching document positions: Vec of (field_id, scored_positions)

fn would_collect(&self, doc_id: DocId, score: Score) -> bool

Whether this score can enter the collector’s retained result set.

fn collect_owned( &mut self, doc_id: DocId, score: Score, positions: MatchedPositions, )

Collect already-owned positions. Position-aware collectors can override this to move the nested vectors instead of cloning them.

fn needs_positions(&self) -> bool

Whether this collector needs position information

fn collect_count(&mut self, _count: u64) -> bool

Accept a known exact number of matches without visiting documents. Return false without changing state to request ordinary collection. This is only offered to score- and position-free collectors.

fn needs_scores(&self) -> bool

Whether this collector consumes scores. Returning false permits the driver to pass 0.0 without evaluating BM25. Position consumers still force scoring; custom collectors retain the previous behavior by default.