Skip to main content

QueryOpts

Struct QueryOpts 

Source
pub struct QueryOpts<'a> {
    pub stats: Option<&'a CorpusStats>,
    pub typo: u32,
    pub fields: &'a [usize],
    pub filter: &'a [Filter<'a>],
    pub sort: Option<Sort<'a>>,
    pub distinct: Option<Distinct<'a>>,
}
Expand description

Everything a MATCH query carries beyond its text and result limit.

Grouping them keeps the query entry point from growing a parameter per clause, and gives every clause one place to be defaulted from (QueryOpts::default is the plain, exact, unscoped query).

Fields§

§stats: Option<&'a CorpusStats>

Corpus-wide BM25 statistics — the second pass of a cross-shard query. None scores against this segment’s own slice.

§typo: u32

Edit distance allowed on bare terms (TYPO n); 0 = exact.

§fields: &'a [usize]

Field positions the query is restricted to (IN <field…>); empty = every field.

§filter: &'a [Filter<'a>]

FILTER: non-scoring predicates, ANDed. Applied before the top-K — filtering afterwards would return fewer hits than exist.

§sort: Option<Sort<'a>>

SORT: select by a stored value instead of by score. Selecting, not re-ordering: a document that wins on the sort key must be chosen even when its score would never have reached the page.

§distinct: Option<Distinct<'a>>

DISTINCT: at most one hit per value of a stored field. Applied during selection, so the page is filled with limit DISTINCT documents rather than limit documents that then collapse.

Trait Implementations§

Source§

impl<'a> Clone for QueryOpts<'a>

Source§

fn clone(&self) -> QueryOpts<'a>

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<'a> Copy for QueryOpts<'a>

Source§

impl<'a> Default for QueryOpts<'a>

Source§

fn default() -> QueryOpts<'a>

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

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for QueryOpts<'a>

§

impl<'a> !Send for QueryOpts<'a>

§

impl<'a> !Sync for QueryOpts<'a>

§

impl<'a> !UnwindSafe for QueryOpts<'a>

§

impl<'a> Freeze for QueryOpts<'a>

§

impl<'a> Unpin for QueryOpts<'a>

§

impl<'a> UnsafeUnpin for QueryOpts<'a>

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, 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> 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.