Struct tantivy::query::RequiredOptionalScorer

pub struct RequiredOptionalScorer<TReqScorer, TOptScorer, TScoreCombiner> { /* fields omitted */ }

Given a required scorer and an optional scorer matches all document from the required scorer and complements the score using the optional scorer.

This is useful for queries like +somethingrequired somethingoptional.

Note that somethingoptional has no impact on the DocSet.

Methods

impl<TReqScorer, TOptScorer, TScoreCombiner> RequiredOptionalScorer<TReqScorer, TOptScorer, TScoreCombiner> where     TOptScorer: DocSet,

pub fn new(     req_scorer: TReqScorer,     opt_scorer: TOptScorer ) -> RequiredOptionalScorer<TReqScorer, TOptScorer, TScoreCombiner>

Creates a new RequiredOptionalScorer.

Trait Implementations

impl<TReqScorer, TOptScorer, TScoreCombiner> DocSet for RequiredOptionalScorer<TReqScorer, TOptScorer, TScoreCombiner> where     TReqScorer: DocSet,     TOptScorer: DocSet,

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 doc(&self) -> DocId

Returns the current document

fn size_hint(&self) -> u32

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

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 append_to_bitset(&mut self, bitset: &mut BitSet)

Appends all docs to a bitset.

fn count(&mut self) -> u32

Returns the number documents matching.

impl<TReqScorer, TOptScorer, TScoreCombiner> Scorer for RequiredOptionalScorer<TReqScorer, TOptScorer, TScoreCombiner> where     TReqScorer: Scorer,     TOptScorer: Scorer,     TScoreCombiner: ScoreCombiner,

fn score(&mut self) -> Score

Returns the score.

fn collect(     &mut self,     collector: &mut Collector,     delete_bitset_opt: Option<&DeleteBitSet> )

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