Struct elasticsearch_dsl::search::queries::specialized::PinnedQuery

pub struct PinnedQuery { /* private fields */ }

The most simple query, which matches all documents, giving them all a _score of 1.0.

To create match_all query:

Query::pinned(PinnedQueryValues::ids([1]), Query::term("user_id", 2))
    .boost(2)
    .name("matches_everything");

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

Implementations

impl PinnedQuery

pub fn boost<B>(self, boost: B) -> Self where
    B: TryInto<Boost>, 

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) -> Self where
    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 PinnedQuery

fn clone(&self) -> PinnedQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PinnedQuery

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

Formats the value using the given formatter.

impl From<PinnedQuery> for Query

fn from(q: PinnedQuery) -> Self

Converts to this type from the input type.

impl From<PinnedQuery> for Option<Query>

fn from(q: PinnedQuery) -> Self

Converts to this type from the input type.

impl From<PinnedQuery> for Queries

fn from(q: PinnedQuery) -> Self

Converts to this type from the input type.

impl PartialEq<PinnedQuery> for PinnedQuery

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

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

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

This method tests for !=.

impl PartialEq<PinnedQuery> for Query

fn eq(&self, other: &PinnedQuery) -> 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 !=.

impl PartialEq<Query> for PinnedQuery

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 !=.

impl Serialize for PinnedQuery

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 PinnedQuery