Struct elasticsearch_dsl::search::queries::shape::ShapeQuery

pub struct ShapeQuery { /* private fields */ }

Queries documents that contain fields indexed using the shape type.

Requires the shape Mapping.

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

Implementations

impl ShapeQuery

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

The shape strategy mapping parameter determines which spatial relation operators may be used at search time.

pub fn ignore_unmapped(self, ignore_unmapped: bool) -> Self

When set to true the ignore_unmapped option will ignore an unmapped field and will not match any documents for this query. This can be useful when querying multiple indexes which might have different mappings. When set to false (the default value) the query will throw an exception if the field is not mapped.

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 ShapeQuery

fn clone(&self) -> ShapeQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShapeQuery

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

Formats the value using the given formatter.

impl From<ShapeQuery> for Option<Query>

fn from(q: ShapeQuery) -> Self

Converts to this type from the input type.

impl From<ShapeQuery> for Query

fn from(q: ShapeQuery) -> Self

Converts to this type from the input type.

impl IntoIterator for ShapeQuery

type Item = ShapeQuery

The type of the elements being iterated over.

type IntoIter = IntoIter<<ShapeQuery 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<Query> for ShapeQuery

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<ShapeQuery> for Query

fn eq(&self, other: &ShapeQuery) -> 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<ShapeQuery> for ShapeQuery

fn eq(&self, other: &ShapeQuery) -> 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 ShapeQuery

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 ShapeQuery