Enum LexicalQuery 

pub enum LexicalQuery {
    Term(TermQuery),
    Phrase {
        terms: Vec<Vec<u8>>,
        slop: u32,
        field: FieldId,
    },
    Prefix {
        prefix: Vec<u8>,
        field: FieldId,
    },
    TermsWithPrefix {
        terms: Vec<Vec<u8>>,
        prefix: Vec<u8>,
        fields: FieldWeights,
    },
    Fuzzy {
        term: Vec<u8>,
        max_distance: u32,
        field: FieldId,
    },
    Phonetic {
        term: Vec<u8>,
        field: FieldId,
    },
}

A structured lexical query over already-analyzed terms.

Variants

Term(TermQuery)

Existing OR-of-terms semantics.

Phrase

Terms must occur in positional phrase order within the declared slop.

Fields

terms: Vec<Vec<u8>>

Analyzed phrase terms in order.

slop: u32

Maximum total positional displacement.

field: FieldId

Field to match.

Prefix

Every indexed term beginning with this analyzed byte prefix.

Fields

prefix: Vec<u8>

Non-empty analyzed prefix.

field: FieldId

Field to match.

TermsWithPrefix

Leading exact terms plus a prefix on the trailing term. Used for type-ahead. Store queries retain at most 32 prefix contributions by highest live document frequency (ties by term bytes), reducing recall above that limit. Exact contributions are unchanged; Prefix remains exhaustive.

Fields

terms: Vec<Vec<u8>>

Analyzed leading terms matched exactly.

prefix: Vec<u8>

Non-empty analyzed trailing prefix.

fields: FieldWeights

Fields and weights shared by the exact and prefix legs.

Fuzzy

Every indexed term within a bounded edit distance.

Fields

term: Vec<u8>

Analyzed source term.

max_distance: u32

Requested edit-distance ceiling, at most two.

field: FieldId

Field to match.

Phonetic

Terms sharing the pinned phonetic code.

Fields

term: Vec<u8>

UTF-8 term whose primary phonetic code is used.

field: FieldId

Field to match.

Implementations

impl LexicalQuery

pub const fn term(query: TermQuery) -> Self

Wraps the compatibility term query.

pub const fn phrase(terms: Vec<Vec<u8>>, slop: u32, field: FieldId) -> Self

Builds a phrase query.

pub const fn prefix(prefix: Vec<u8>, field: FieldId) -> Self

Builds a prefix query.

pub const fn fuzzy(term: Vec<u8>, max_distance: u32, field: FieldId) -> Self

Builds a bounded fuzzy query.

pub const fn phonetic(term: Vec<u8>, field: FieldId) -> Self

Builds a phonetic query.

Trait Implementations

impl Clone for LexicalQuery

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LexicalQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for LexicalQuery

impl PartialEq for LexicalQuery

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LexicalQuery