Skip to main content

TrigramQuery

Struct TrigramQuery 

Source
pub struct TrigramQuery {
    pub dnfs: Vec<TrigramDnf>,
}
Expand description

A boolean query over trigrams: a conjunction of DNFs. A document is a candidate when it satisfies every DNF, where a DNF is satisfied when at least one of its AND-groups is fully present in the document.

This one shape expresses everything the planner produces:

  • an exact literal is one DNF with a single AND-group (all its trigrams);
  • a case-insensitive literal contributes one DNF per needle window, each a disjunction of single-trigram groups (the window’s fold variants);
  • a regex contributes a DNF for its required prefix literals and another for its required suffix literals.

A DNF that cannot filter (it is empty, or contains an empty group, which would make it trivially true) is ignored. An empty query means “scan everything”.

Fields§

§dnfs: Vec<TrigramDnf>

Implementations§

Source§

impl TrigramQuery

Source

pub fn is_unconstrained(&self) -> bool

True when no usable trigram constraints exist and all documents are candidates.

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 one DNF listing every byte sequence the window can begin with in a match, so the trigram index can still prune candidates without false negatives.

The matcher folds case Unicode-aware, so a window’s variants are not just its ASCII case permutations: s/S also matches U+017F (LATIN SMALL LETTER LONG S) and k/K also matches U+212A (KELVIN SIGN), whose UTF-8 encodings are multi-byte. For each window we enumerate every combination of per-character fold forms and take the first three bytes of each — exactly the set of trigrams a match of that window can start with. Windows containing non-ASCII needle bytes are skipped (their fold forms aren’t enumerable this way), which only widens the candidate set.

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