Trait tantivy::collector::SegmentCollector

pub trait SegmentCollector: 'static {
    type Fruit: Fruit;
    fn collect(&mut self, doc: DocId, score: Score);
    fn harvest(self) -> Self::Fruit;
}

The SegmentCollector is the trait in charge of defining the collect operation at the scale of the segment.

.collect(doc, score) will be called for every documents matching the query.

Associated Types

type Fruit: Fruit

Fruit is the type for the result of our collection. e.g. usize for the Count collector.

Required methods

fn collect(&mut self, doc: DocId, score: Score)

The query pushes the scored document to the collector via this method.

fn harvest(self) -> Self::Fruit

Extract the fruit of the collection from the SegmentCollector.

Implementations on Foreign Types

impl SegmentCollector for Box<dyn BoxableSegmentCollector>

type Fruit = Box<dyn Fruit>

fn collect(&mut self, doc: u32, score: Score)

fn harvest(self) -> Box<dyn Fruit>

impl<TSegmentCollector: SegmentCollector> SegmentCollector for Option<TSegmentCollector>

type Fruit = Option<TSegmentCollector::Fruit>

fn collect(&mut self, doc: DocId, score: Score)

fn harvest(self) -> Self::Fruit

impl<Left, Right> SegmentCollector for (Left, Right) where
    Left: SegmentCollector,
    Right: SegmentCollector, 

type Fruit = (Left::Fruit, Right::Fruit)

fn collect(&mut self, doc: DocId, score: Score)

fn harvest(self) -> <Self as SegmentCollector>::Fruit

impl<One, Two, Three> SegmentCollector for (One, Two, Three) where
    One: SegmentCollector,
    Two: SegmentCollector,
    Three: SegmentCollector, 

type Fruit = (One::Fruit, Two::Fruit, Three::Fruit)

fn collect(&mut self, doc: DocId, score: Score)

fn harvest(self) -> <Self as SegmentCollector>::Fruit

impl<One, Two, Three, Four> SegmentCollector for (One, Two, Three, Four) where
    One: SegmentCollector,
    Two: SegmentCollector,
    Three: SegmentCollector,
    Four: SegmentCollector, 

type Fruit = (One::Fruit, Two::Fruit, Three::Fruit, Four::Fruit)

fn collect(&mut self, doc: DocId, score: Score)

fn harvest(self) -> <Self as SegmentCollector>::Fruit

Implementors