Enum ApiError

pub enum ApiError {
    IndexNotFound {
        index: String,
    },
    DocumentMissing {
        index: String,
    },
    IndexAlreadyExists {
        index: String,
    },
    Parsing {
        line: u64,
        col: u64,
        reason: String,
    },
    MapperParsing {
        reason: String,
    },
    ActionRequestValidation {
        reason: String,
    },
    Other(Map<String, Value>),
    // some variants omitted
}

A REST API error response.

Variants

IndexNotFound

An index wasn’t found.

Some endpoints, like search, will return an IndexNotFound error if a request is made to a missing index. Other endpoints will return a successful response even if the index is missing but include some error property in the response body.

Fields

index: String

DocumentMissing

A document wasn’t found.

This error can occur when attempting to update a document that doesn’t already exist.

Fields

index: String

IndexAlreadyExists

An index already exists but was expected to.

Attempting to create an index with a name that’s already in use will result in an IndexAlreadyExists error.

Fields

index: String

Parsing

The request body contains invalid data.

If a Query DSL query contains invalid JSON or unrecognised properties then Elasticsearch will return a Parsing error.

Fields

line: u64

col: u64

reason: String

MapperParsing

The document mapping contains invalid data.

If a put mapping request contains invalid JSON or unrecognised properties then Elasticsearch will return a MapperParsing error.

Fields

reason: String

ActionRequestValidation

The request body can’t be processed.

Some endpoints that expect certain constraints of a request to hold will return an ActionRequestValidation error if those constraints aren’t met.

Fields

reason: String

Other(Map<String, Value>)

A currently unrecognised error occurred.

WARNING: Don’t rely on this variant to capture an error. As new variants are introduced they will no longer be matched by ApiError::Other. For this reason, this variant will disappear in the future.

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiError

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<ApiError> for ResponseError

fn from(err: ApiError) -> ResponseError

Converts to this type from the input type.

impl From<Map<String, Value>> for ApiError

fn from(value: Map<String, Value>) -> Self

Converts to this type from the input type.

impl PartialEq for ApiError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ApiError