Struct tantivy::query::ConstScorer

pub struct ConstScorer<TDocSet: DocSet> { /* fields omitted */ }

Wraps a DocSet and simply returns a constant Scorer. The ConstScorer is useful if you have a DocSet where you needed a scorer.

The ConstScorer's constant score can be set by calling .set_score(...).

Methods

impl<TDocSet: DocSet> ConstScorer<TDocSet>

pub fn new(docset: TDocSet) -> ConstScorer<TDocSet>

Creates a new ConstScorer.

pub fn set_score(&mut self, score: Score)

Sets the constant score to a different value.

Trait Implementations

impl<TDocSet: DocSet> DocSet for ConstScorer<TDocSet>

fn advance(&mut self) -> bool

Goes to the next element. .advance(...) needs to be called a first time to point to the correct element.

fn skip_next(&mut self, target: DocId) -> SkipResult

After skipping, position the iterator in such a way that .doc() will return a value greater than or equal to target.

fn fill_buffer(&mut self, buffer: &mut [DocId]) -> usize

Fills a given mutable buffer with the next doc ids from the DocSet

fn doc(&self) -> DocId

Returns the current document

fn size_hint(&self) -> u32

Returns a best-effort hint of the length of the docset.

fn append_to_bitset(&mut self, bitset: &mut BitSet)

Appends all docs to a bitset.

fn next(&mut self) -> Option<DocId>

Advances the cursor to the next document None is returned if the iterator has DocSet has already been entirely consumed.

impl<TDocSet: DocSet> Scorer for ConstScorer<TDocSet>

fn score(&self) -> Score

Returns the score.

fn collect(&mut self, collector: &mut Collector)

Consumes the complete DocSet and push the scored documents to the collector.