Struct tantivy::collector::TopCollector

pub struct TopCollector { /* fields omitted */ }

The Top Collector keeps track of the K documents with the best scores.

The implementation is based on a BinaryHeap. The theorical complexity is O(n log K).

Methods

impl TopCollector

pub fn with_limit(limit: usize) -> TopCollector

Creates a top collector, with a number of documents equal to "limit".

Panics

The method panics if limit is 0

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn docs(&self) -> Vec<DocAddress>

Returns K best documents sorted in decreasing order.

Calling this method triggers the sort. The result of the sort is not cached.

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn score_docs(&self) -> Vec<(Score, DocAddress)>

Returns K best ScoredDocument sorted in decreasing order.

Calling this method triggers the sort. The result of the sort is not cached.

pub fn at_capacity(&self) -> bool

Return true iff at least K documents have gone through the collector.

Trait Implementations

impl Collector for TopCollector

fn set_segment(
    &mut self,
    segment_id: SegmentLocalId,
    _: &SegmentReader
) -> Result<()>

set_segment is called before beginning to enumerate on this segment.

fn collect(&mut self, doc: DocId, score: Score)

The query pushes the scored document to the collector via this method.