Struct elasticsearch_dsl::search::queries::specialized::PercolateQuery

pub struct PercolateQuery { /* private fields */ }

The percolate query can be used to match queries stored in an index. The percolate query itself contains the document that will be used as query to match with the stored queries.

To percolate single document:

Query::percolate("field", json!({ "message": "search text" }));

To percolate multiple documents:

Query::percolate("field", vec![json!({ "message": "search text" }), json!({ "message": "another search text" })]);

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

Implementations

impl PercolateQuery

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

The suffix to be used for the _percolator_document_slot field in case multiple percolate queries have been specified. This is an optional parameter

Trait Implementations

impl Clone for PercolateQuery

fn clone(&self) -> PercolateQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PercolateQuery

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

Formats the value using the given formatter.

impl From<PercolateQuery> for Option<Query>

fn from(q: PercolateQuery) -> Self

Converts to this type from the input type.

impl From<PercolateQuery> for Query

fn from(q: PercolateQuery) -> Self

Converts to this type from the input type.

impl IntoIterator for PercolateQuery

type Item = PercolateQuery

The type of the elements being iterated over.

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

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

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

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

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

Serialize this value into the given Serde serializer.

impl Eq for PercolateQuery

impl StructuralEq for PercolateQuery

impl StructuralPartialEq for PercolateQuery