Skip to main content

BoolQuery

Struct BoolQuery 

Source
pub struct BoolQuery { /* private fields */ }
Expand description

Clauses combined.

The four slots differ in two ways that are easy to confuse:

  • must and should affect the score; filter and must_not do not, and are cached, so anything that is a yes-or-no test belongs in filter.
  • must, filter and must_not are requirements. should is one only when nothing else in the query is — otherwise it merely raises the score of documents that match it. BoolQuery::minimum_should_match is what turns it back into a requirement, and Query::any_of does that for you.

Implementations§

Source§

impl BoolQuery

Source

pub fn must(self, query: impl Into<Query>) -> BoolQuery

Required, and contributes to the score.

Source

pub fn should(self, query: impl Into<Query>) -> BoolQuery

Optional, and raises the score of documents that match — unless BoolQuery::minimum_should_match makes it a requirement.

Source

pub fn must_not(self, query: impl Into<Query>) -> BoolQuery

Must not match. Does not affect the score.

Source

pub fn filter(self, query: impl Into<Query>) -> BoolQuery

Required, but contributes nothing to the score and is cached.

The right slot for a status, an owner, a date window — anything where the answer is yes or no rather than “how well”.

Source

pub fn minimum_should_match(self, value: impl Into<Json>) -> BoolQuery

How many of the should clauses have to match: a count, a negative count, or a percentage like "50%".

Trait Implementations§

Source§

impl Clone for BoolQuery

Source§

fn clone(&self) -> Self

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 BoolQuery

Source§

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

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

impl Default for BoolQuery

Source§

fn default() -> Self

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

impl From<BoolQuery> for Query

Source§

fn from(value: BoolQuery) -> Query

Converts to this type from the input type.
Source§

impl PartialEq for BoolQuery

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BoolQuery

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, 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.