Struct tantivy::query::Exclude

pub struct Exclude<TDocSet, TDocSetExclude> { /* fields omitted */ }

Filters a given DocSet by removing the docs from a given DocSet.

The excluding docset has no impact on scoring.

Implementations

impl<TDocSet, TDocSetExclude> Exclude<TDocSet, TDocSetExclude> where
    TDocSet: DocSet,
    TDocSetExclude: DocSet, 

pub fn new(
    underlying_docset: TDocSet,
    excluding_docset: TDocSetExclude
) -> Exclude<TDocSet, TDocSetExclude>

Creates a new ExcludeScorer

Trait Implementations

impl<TDocSet, TDocSetExclude> DocSet for Exclude<TDocSet, TDocSetExclude> where
    TDocSet: DocSet,
    TDocSetExclude: DocSet, 

fn size_hint(&self) -> u32

.size_hint() directly returns the size of the underlying docset without taking in account the fact that docs might be deleted.

fn advance(&mut self) -> DocId

Goes to the next element.

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

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

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<TScorer, TDocSetExclude> Scorer for Exclude<TScorer, TDocSetExclude> where
    TScorer: Scorer,
    TDocSetExclude: DocSet + 'static, 

fn score(&mut self) -> Score

Returns the score.