Struct elastiql::search::query::TermQuery

pub struct TermQuery {
    pub field: String,
    pub value: String,
    pub boost: Option<f64>,
}

A Term query returns documents that contain an exact term in a provided field.

Fields

field: String

The name of the field to query.

value: String

A list of terms you wish to find in the provided field. To return a document, one or more terms must exactly match a field value, including whitespace and capitalization.

Although this field is a String, it will match numerical fields; e.g. "1.2" will match fields containing the floating point value 1.2.

boost: Option<f64>

Floating point number used to decrease or increase the relevance scores of a query. (Defaults to 1.0.)

You can use the boost parameter to adjust relevance scores for searches containing two or more queries.

Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

Implementations

impl TermQuery

pub fn builder() -> TermQueryBuilder<((), (), ())>

Create a builder for building TermQuery. On the builder, call .field(...), .value(...), .boost(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of TermQuery.

impl TermQuery

pub fn new(field: impl Into<String>, value: impl Into<String>) -> Self

Constructs a new TermQuery.

Trait Implementations

impl Clone for TermQuery

fn clone(&self) -> TermQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TermQuery

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TermQuery

fn deserialize<D>(deserializer: D) -> Result<TermQuery, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<TermQuery> for Query

fn from(filter: TermQuery) -> Query

Performs the conversion.

impl Serialize for TermQuery

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.