Skip to main content

TrigramQuery

Struct TrigramQuery 

Source
pub struct TrigramQuery {
    pub or_groups: Vec<Vec<Trigram>>,
    pub and_clauses: Vec<Vec<Trigram>>,
}
Expand description

A boolean query over trigrams supporting two complementary shapes:

  • or_groups is disjunctive normal form (DNF): each inner group is an AND of trigrams and the outer set is an OR of groups. Used for exact literals and regex required-literal alternations.
  • and_clauses is conjunctive normal form (CNF): each inner clause is an OR of trigrams and a document must satisfy every clause. Used for case-insensitive literals, where each needle position contributes the OR of its case variants.

A document is a candidate if it satisfies the DNF part (or the DNF part is empty) and every CNF clause. An empty query means “scan everything”.

Fields§

§or_groups: Vec<Vec<Trigram>>§and_clauses: Vec<Vec<Trigram>>

Implementations§

Source§

impl TrigramQuery

Source

pub fn is_unconstrained(&self) -> bool

True when no usable trigram constraints exist and all documents are candidates. A group/clause that is empty means that part can’t filter.

Source

pub fn from_literal(needle: &[u8]) -> TrigramQuery

Source

pub fn from_literal_ci(needle: &[u8]) -> TrigramQuery

Build a case-insensitive literal query. Each 3-byte window of the needle becomes a CNF clause listing every ASCII-case variant of that window, so the trigram index can still prune candidates without false negatives.

A window is only usable as a clause when all three of its bytes are ASCII-case-safe (see [ci_safe]): otherwise the case-insensitive matcher (Unicode-aware) could match bytes we did not enumerate, and requiring the ASCII trigrams would drop real matches. Unsafe windows are skipped, which only widens the candidate set. If no usable window remains, the query is unconstrained and every document is scanned.

Trait Implementations§

Source§

impl Clone for TrigramQuery

Source§

fn clone(&self) -> TrigramQuery

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TrigramQuery

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TrigramQuery

Source§

fn default() -> TrigramQuery

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more