Struct Explain

pub struct Explain<'a, 'b, B> { /* private fields */ }

Builder for the Explain API

Returns information about why a specific matches (or doesn’t match) a query.

Implementations

impl<'a, 'b, B> Explain<'a, 'b, B>

where B: Body,

pub fn new(transport: &'a Transport, parts: ExplainParts<'b>) -> Self

Creates a new instance of Explain with the specified API parts

pub fn _source(self, _source: &'b [&'b str]) -> Self

True or false to return the _source field or not, or a list of fields to return

pub fn _source_excludes(self, _source_excludes: &'b [&'b str]) -> Self

A list of fields to exclude from the returned _source field

pub fn _source_includes(self, _source_includes: &'b [&'b str]) -> Self

A list of fields to extract and return from the _source field

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

Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)

pub fn analyzer(self, analyzer: &'b str) -> Self

The analyzer for the query string query

pub fn body<T>(self, body: T) -> Explain<'a, 'b, JsonBody<T>>

where T: Serialize,

The body for the API call

pub fn default_operator(self, default_operator: DefaultOperator) -> Self

The default operator for query string query (AND or OR)

pub fn df(self, df: &'b str) -> Self

The default field for query string query (default: _all)

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

Include the stack trace of returned errors.

pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self

A comma-separated list of filters used to reduce the response.

pub fn header(self, key: HeaderName, value: HeaderValue) -> Self

Adds a HTTP header

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

Return human readable values for statistics.

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

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

pub fn preference(self, preference: &'b str) -> Self

Specify the node or shard the operation should be performed on (default: random)

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

Pretty format the returned JSON response.

pub fn q(self, q: &'b str) -> Self

Query in the Lucene query string syntax

pub fn request_timeout(self, timeout: Duration) -> Self

Sets a request timeout for this API call.

The timeout is applied from when the request starts connecting until the response body has finished.

pub fn routing(self, routing: &'b str) -> Self

Specific routing value

pub fn source(self, source: &'b str) -> Self

The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

pub fn stored_fields(self, stored_fields: &'b [&'b str]) -> Self

A comma-separated list of stored fields to return in the response

pub async fn send(self) -> Result<Response, Error>

Creates an asynchronous call to the Explain API that can be awaited

Trait Implementations

impl<'a, 'b, B: Clone> Clone for Explain<'a, 'b, B>

fn clone(&self) -> Explain<'a, 'b, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, 'b, B: Debug> Debug for Explain<'a, 'b, B>

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

Formats the value using the given formatter.