Struct Query

Source
pub struct Query(/* private fields */);
Expand description

A parsed query, ready for use in a search

Implementations§

Source§

impl Query

Source

pub fn combine(op: Operator, a: impl AsRef<Query>, b: impl AsRef<Query>) -> Self

Construct a Query by combining two others with the specified Operator

Source

pub fn combine_terms( op: Operator, a: impl AsRef<str>, b: impl AsRef<str>, ) -> Self

Construct a Query by combining two terms with the specified Operator

Source

pub fn match_all() -> Self

Construct a Query that matches any document

Source

pub fn match_nothing() -> Self

Construct a Query that matches no documents

Source

pub fn scale(factor: f64, subquery: impl AsRef<Query>) -> Self

Scale the weight of the specified Query using the given factor

Source

pub fn term( term: impl AsRef<str>, wqf: impl Into<Option<u32>>, pos: impl Into<Option<u32>>, ) -> Self

Construct a Query for the given term

Source

pub fn value_ge(slot: impl Into<Slot>, lower: impl ToCxxString) -> Self

Construct a query for a single-ended value range

Source

pub fn value_le(slot: impl Into<Slot>, upper: impl ToCxxString) -> Self

Construct a query for a single-ended value range

Source

pub fn value_range( slot: impl Into<Slot>, lower: impl ToCxxString, upper: impl ToCxxString, ) -> Self

Construct a Query for a value range

Source

pub fn wildcard( pattern: impl AsRef<str>, max_expansion: impl Into<Option<u32>>, limit_behavior: impl Into<Option<WildcardLimitBehavior>>, combiner: impl Into<Option<WildcardCombiner>>, ) -> Self

Construct a Query for a wildcard queries

Source

pub fn is_invalid(&self) -> bool

Returns true if this Query is invalid

Source

pub fn operator(&self) -> Operator

Returns the Operator for this Query

Source

pub fn subqueries(&self) -> SubqueryIter<'_>

Return an iterator over the subqueries contained in this Query

Source

pub fn terms(&self) -> TermIter

Return an iterator over the terms contained in this Query

Source

pub fn unique_terms(&self) -> TermIter

Return an iterator over the unique terms contained in this Query

Trait Implementations§

Source§

impl BitAnd for Query

Source§

type Output = Query

The resulting type after applying the & operator.
Source§

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation. Read more
Source§

impl BitOr for Query

Source§

type Output = Query

The resulting type after applying the | operator.
Source§

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation. Read more
Source§

impl BitXor for Query

Source§

type Output = Query

The resulting type after applying the ^ operator.
Source§

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation. Read more
Source§

impl Clone for Query

Source§

fn clone(&self) -> Query

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Query

Source§

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

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

impl Default for Query

Source§

fn default() -> Self

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

impl Display for Query

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Query

§

impl !RefUnwindSafe for Query

§

impl !Send for Query

§

impl !Sync for Query

§

impl Unpin for Query

§

impl UnwindSafe for Query

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.