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.

Methods

impl<TDocSet, TDocSetExclude> Exclude<TDocSet, TDocSetExclude> where
    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 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 doc(&self) -> DocId

Returns the current document

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 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, 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.

fn for_each(&mut self, callback: &mut dyn FnMut(DocId, Score))

Iterates through all of the document matched by the DocSet DocSet and push the scored documents to the collector.