Struct elasticsearch_dsl::search::queries::term_level::RangeQuery

pub struct RangeQuery { /* private fields */ }

Returns documents that contain terms within a provided range.

To create a range query with numeric values:

Query::range("numeric_field")
    .gt(1)
    .lt(3)
    .boost(2)
    .name("range_query");

https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html

Implementations

impl RangeQuery

pub fn gt<T>(self, gt: T) -> Selfwhere
    T: Serialize,

Greater than.

pub fn gte<T>(self, gte: T) -> Selfwhere
    T: Serialize,

Greater than or equal to.

pub fn lt<T>(self, lt: T) -> Selfwhere
    T: Serialize,

Less than.

pub fn lte<T>(self, lte: T) -> Selfwhere
    T: Serialize,

Less than or equal to.

pub fn format<T>(self, format: T) -> Selfwhere
    T: ToString,

Date format used to convert date values in the query.

By default, Elasticsearch uses the date format provided in the <field>’s mapping. This value overrides that mapping format.

For valid syntax, see format.

If a format or date value is incomplete, the range query replaces any missing components with default values. See Missing date components.

pub fn relation(self, relation: RangeRelation) -> Self

Indicates how the range query matches values for range fields.

pub fn time_zone<T>(self, time_zone: T) -> Selfwhere
    T: ToString,

Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC.

Valid values are ISO 8601 UTC offsets, such as +01:00 or -08:00, and IANA time zone IDs, such as America/Los_Angeles.

For an example query using the time_zone parameter, see Time zone in range queries.

pub fn boost<T>(self, boost: T) -> Selfwhere
    T: AsPrimitive<f32>,

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.

pub fn name<S>(self, name: S) -> Selfwhere
    S: ToString,

You can use named queries to track which queries matched returned documents. If named queries are used, the response includes a matched_queries property for each hit.

https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html#named-queries

Trait Implementations

impl Clone for RangeQuery

fn clone(&self) -> RangeQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RangeQuery

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

Formats the value using the given formatter.

impl From<RangeQuery> for MultiTermQuery

fn from(q: RangeQuery) -> Self

Converts to this type from the input type.

impl From<RangeQuery> for Option<MultiTermQuery>

fn from(q: RangeQuery) -> Self

Converts to this type from the input type.

impl From<RangeQuery> for Option<Query>

fn from(q: RangeQuery) -> Self

Converts to this type from the input type.

impl From<RangeQuery> for Query

fn from(q: RangeQuery) -> Self

Converts to this type from the input type.

impl IntoIterator for RangeQuery

type Item = RangeQuery

The type of the elements being iterated over.

type IntoIter = IntoIter<<RangeQuery as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<MultiTermQuery> for RangeQuery

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

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

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 PartialEq<Query> for RangeQuery

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

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

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 PartialEq<RangeQuery> for MultiTermQuery

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

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

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 PartialEq<RangeQuery> for Query

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

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

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 PartialEq<RangeQuery> for RangeQuery

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

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

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 Serialize for RangeQuery

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RangeQuery