Struct tantivy::collector::FilterCollector

pub struct FilterCollector<TCollector, TPredicate, TPredicateValue: FastValue> where
    TPredicate: 'static,  { /* fields omitted */ }

The FilterCollector collector filters docs using a u64 fast field value and a predicate. Only the documents for which the predicate returned "true" will be passed on to the next collector.

use tantivy::collector::{TopDocs, FilterCollector};
use tantivy::query::QueryParser;
use tantivy::schema::{Schema, TEXT, INDEXED, FAST};
use tantivy::{doc, DocAddress, Index};

let mut schema_builder = Schema::builder();
let title = schema_builder.add_text_field("title", TEXT);
let price = schema_builder.add_u64_field("price", INDEXED | FAST);
let schema = schema_builder.build();
let index = Index::create_in_ram(schema);

let mut index_writer = index.writer_with_num_threads(1, 10_000_000).unwrap();
index_writer.add_document(doc!(title => "The Name of the Wind", price => 30_200u64));
index_writer.add_document(doc!(title => "The Diary of Muadib", price => 29_240u64));
index_writer.add_document(doc!(title => "A Dairy Cow", price => 21_240u64));
index_writer.add_document(doc!(title => "The Diary of a Young Girl", price => 20_120u64));
assert!(index_writer.commit().is_ok());

let reader = index.reader().unwrap();
let searcher = reader.searcher();

let query_parser = QueryParser::for_index(&index, vec![title]);
let query = query_parser.parse_query("diary").unwrap();
let no_filter_collector = FilterCollector::new(price, &|value: u64| value > 20_120u64, TopDocs::with_limit(2));
let top_docs = searcher.search(&query, &no_filter_collector).unwrap();

assert_eq!(top_docs.len(), 1);
assert_eq!(top_docs[0].1, DocAddress(0, 1));

let filter_all_collector: FilterCollector<_, _, u64> = FilterCollector::new(price, &|value| value < 5u64, TopDocs::with_limit(2));
let filtered_top_docs = searcher.search(&query, &filter_all_collector).unwrap();

assert_eq!(filtered_top_docs.len(), 0);

Implementations

impl<TCollector, TPredicate, TPredicateValue: FastValue> FilterCollector<TCollector, TPredicate, TPredicateValue> where
    TCollector: Collector + Send + Sync,
    TPredicate: Fn(TPredicateValue) -> bool + Send + Sync, 

pub fn new(
    field: Field,
    predicate: &'static TPredicate,
    collector: TCollector
) -> FilterCollector<TCollector, TPredicate, TPredicateValue>

Create a new FilterCollector.

Trait Implementations

impl<TCollector, TPredicate, TPredicateValue: FastValue> Collector for FilterCollector<TCollector, TPredicate, TPredicateValue> where
    TCollector: Collector + Send + Sync,
    TPredicate: 'static + Fn(TPredicateValue) -> bool + Send + Sync,
    TPredicateValue: 'static + FastValue, 

type Fruit = TCollector::Fruit

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

type Child = FilterSegmentCollector<TCollector::Child, TPredicate, TPredicateValue>

Type of the SegmentCollector associated to this collector.

fn for_segment(
    &self,
    segment_local_id: u32,
    segment_reader: &SegmentReader
) -> Result<FilterSegmentCollector<TCollector::Child, TPredicate, TPredicateValue>>

set_segment is called before beginning to enumerate on this segment.

fn requires_scoring(&self) -> bool

Returns true iff the collector requires to compute scores for documents.

fn merge_fruits(
    &self,
    segment_fruits: Vec<<TCollector::Child as SegmentCollector>::Fruit>
) -> Result<TCollector::Fruit>

Combines the fruit associated to the collection of each segments into one fruit.

fn collect_segment(
    &self,
    weight: &dyn Weight,
    segment_ord: u32,
    reader: &SegmentReader
) -> Result<<Self::Child as SegmentCollector>::Fruit>

Created a segment collector and