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.

Implementations

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) -> DocId

Goes to the next element.

fn doc(&self) -> DocId

Returns the current document Right after creating a new DocSet, the docset points to the first document.

fn size_hint(&self) -> u32

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

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

Advances the DocSet forward until reaching the target, or going to the lowest DocId greater than the target.

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

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

fn count(&mut self, delete_bitset: &DeleteBitSet) -> u32

Returns the number documents matching. Calling this method consumes the DocSet.

fn count_including_deleted(&mut self) -> u32

Returns the count of documents, deleted or not. Calling this method consumes the DocSet.

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.