Trait Query 

pub trait Query:
    Display
    + Send
    + Sync {
    // Required methods
    fn scorer<'a>(
        &self,
        reader: &'a SegmentReader,
        limit: usize,
    ) -> ScorerFuture<'a>;
    fn count_estimate<'a>(&self, reader: &'a SegmentReader) -> CountFuture<'a>;

    // Provided methods
    fn scorer_with_options<'a>(
        &self,
        reader: &'a SegmentReader,
        limit: usize,
        options: ScorerOptions,
    ) -> ScorerFuture<'a> { ... }
    fn scorer_sync<'a>(
        &self,
        reader: &'a SegmentReader,
        limit: usize,
    ) -> Result<Box<dyn Scorer + 'a>> { ... }
    fn scorer_sync_with_options<'a>(
        &self,
        reader: &'a SegmentReader,
        limit: usize,
        options: ScorerOptions,
    ) -> Result<Box<dyn Scorer + 'a>> { ... }
    fn decompose(&self) -> QueryDecomposition { ... }
    fn is_filter(&self) -> bool { ... }
    fn as_doc_predicate<'a>(
        &self,
        _reader: &'a SegmentReader,
    ) -> Option<DocPredicate<'a>> { ... }
    fn as_doc_bitset(&self, _reader: &SegmentReader) -> Option<DocBitset> { ... }
    fn bitset_cardinality_estimate(
        &self,
        _reader: &SegmentReader,
    ) -> Option<u64> { ... }
}

A search query (async)

Note: scorer takes &self (not &'a self) so that scorers don’t borrow the query. This enables query composition - queries can create sub-queries locally and get their scorers. Implementations must clone/capture any data they need during scorer creation.

Required Methods

fn scorer<'a>( &self, reader: &'a SegmentReader, limit: usize, ) -> ScorerFuture<'a>

Create a scorer for this query against a single segment (async)

The limit parameter specifies the maximum number of results to return. This is passed from the top-level search limit.

Note: The scorer borrows only the reader, not the query. Implementations should capture any needed query data (field, terms, etc.) during creation.

fn count_estimate<'a>(&self, reader: &'a SegmentReader) -> CountFuture<'a>

Estimated number of matching documents in a segment (async)

Provided Methods

fn scorer_with_options<'a>( &self, reader: &'a SegmentReader, limit: usize, options: ScorerOptions, ) -> ScorerFuture<'a>

Create a scorer with collector-specific construction options. Query implementations that can avoid optional position data should override this; the default preserves existing behavior.

fn scorer_sync<'a>( &self, reader: &'a SegmentReader, limit: usize, ) -> Result<Box<dyn Scorer + 'a>>

Create a scorer synchronously (mmap/RAM only).

Available when the sync feature is enabled. Default implementation returns an error.

fn scorer_sync_with_options<'a>( &self, reader: &'a SegmentReader, limit: usize, options: ScorerOptions, ) -> Result<Box<dyn Scorer + 'a>>

Synchronous counterpart to Query::scorer_with_options.

fn decompose(&self) -> QueryDecomposition

Decompose this query for MaxScore optimization.

Returns TextTerm for simple term queries, SparseTerms for sparse vector queries (single or multi-dim), or Opaque if the query cannot be decomposed.

fn is_filter(&self) -> bool

True if this query is a pure filter (always scores 1.0, no positions). Used by the planner to convert non-selective MUST filters into predicates.

fn as_doc_predicate<'a>( &self, _reader: &'a SegmentReader, ) -> Option<DocPredicate<'a>>

For filter queries: return a cheap per-doc predicate against a segment. The predicate does O(1) work per doc (e.g., fast-field lookup).

fn as_doc_bitset(&self, _reader: &SegmentReader) -> Option<DocBitset>

Build a compact bitset of matching doc_ids for this query.

Preferred over as_doc_predicate for BMP filtered queries because bitset lookup is ~2ns vs ~30-40ns for a fast-field closure. Default returns None; TermQuery overrides this to build from its posting list in O(M) time.

fn bitset_cardinality_estimate(&self, _reader: &SegmentReader) -> Option<u64>

Cheap estimate of how many docs this filter clause matches in the segment. Used by the boolean planner to order MUST/MUST_NOT evaluation: the narrowest clause is materialized first and wider clauses refine it with per-doc probes instead of being fully materialized. None = unknown (treated as matching everything).

Trait Implementations

impl Query for Box<dyn Query>

fn scorer<'a>( &self, reader: &'a SegmentReader, limit: usize, ) -> ScorerFuture<'a>

Create a scorer for this query against a single segment (async)

fn count_estimate<'a>(&self, reader: &'a SegmentReader) -> CountFuture<'a>

Estimated number of matching documents in a segment (async)

fn scorer_with_options<'a>( &self, reader: &'a SegmentReader, limit: usize, options: ScorerOptions, ) -> ScorerFuture<'a>

Create a scorer with collector-specific construction options. Query implementations that can avoid optional position data should override this; the default preserves existing behavior.

fn decompose(&self) -> QueryDecomposition

Decompose this query for MaxScore optimization.

fn is_filter(&self) -> bool

True if this query is a pure filter (always scores 1.0, no positions). Used by the planner to convert non-selective MUST filters into predicates.

fn as_doc_predicate<'a>( &self, reader: &'a SegmentReader, ) -> Option<DocPredicate<'a>>

For filter queries: return a cheap per-doc predicate against a segment. The predicate does O(1) work per doc (e.g., fast-field lookup).

fn as_doc_bitset(&self, reader: &SegmentReader) -> Option<DocBitset>

Build a compact bitset of matching doc_ids for this query.

fn bitset_cardinality_estimate(&self, reader: &SegmentReader) -> Option<u64>

Cheap estimate of how many docs this filter clause matches in the segment. Used by the boolean planner to order MUST/MUST_NOT evaluation: the narrowest clause is materialized first and wider clauses refine it with per-doc probes instead of being fully materialized. None = unknown (treated as matching everything).

fn scorer_sync<'a>( &self, reader: &'a SegmentReader, limit: usize, ) -> Result<Box<dyn Scorer + 'a>>

Create a scorer synchronously (mmap/RAM only).

fn scorer_sync_with_options<'a>( &self, reader: &'a SegmentReader, limit: usize, options: ScorerOptions, ) -> Result<Box<dyn Scorer + 'a>>

Synchronous counterpart to Query::scorer_with_options.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Query for Box<dyn Query>

fn scorer<'a>( &self, reader: &'a SegmentReader, limit: usize, ) -> ScorerFuture<'a>

fn count_estimate<'a>(&self, reader: &'a SegmentReader) -> CountFuture<'a>

fn scorer_with_options<'a>( &self, reader: &'a SegmentReader, limit: usize, options: ScorerOptions, ) -> ScorerFuture<'a>

fn decompose(&self) -> QueryDecomposition

fn is_filter(&self) -> bool

fn as_doc_predicate<'a>( &self, reader: &'a SegmentReader, ) -> Option<DocPredicate<'a>>

fn as_doc_bitset(&self, reader: &SegmentReader) -> Option<DocBitset>

fn bitset_cardinality_estimate(&self, reader: &SegmentReader) -> Option<u64>

fn scorer_sync<'a>( &self, reader: &'a SegmentReader, limit: usize, ) -> Result<Box<dyn Scorer + 'a>>

fn scorer_sync_with_options<'a>( &self, reader: &'a SegmentReader, limit: usize, options: ScorerOptions, ) -> Result<Box<dyn Scorer + 'a>>

Implementors

impl Query for BinaryDenseVectorQuery

impl Query for BooleanQuery

impl Query for BoostQuery

impl Query for DenseVectorQuery

impl Query for PhraseQuery

impl Query for PrefixQuery

impl Query for RangeQuery

impl Query for SparseTermQuery

impl Query for SparseVectorQuery

impl Query for TermQuery