Enum tantivy_query_grammar::Occur

pub enum Occur {
    Should,
    Must,
    MustNot,
}

Defines whether a term in a query must be present, should be present or must not be present.

Variants

Should

For a given document to be considered for scoring, at least one of the terms with the Should or the Must Occur constraint must be within the document.

Must

Document without the term are excluded from the search.

MustNot

Document that contain the term are excluded from the search.

Implementations

impl Occur

pub fn compose(left: Occur, right: Occur) -> Occur

Compose two occur values.

Trait Implementations

impl Clone for Occur

fn clone(&self) -> Occur

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Occur

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

Formats the value using the given formatter.

impl Display for Occur

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

Formats the value using the given formatter.

impl Hash for Occur

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Occur> for Occur

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Occur

impl Eq for Occur

impl StructuralEq for Occur

impl StructuralPartialEq for Occur