Enum Error 

#[non_exhaustive]
pub enum Error {
    Configuration(String),
    InvalidRequest(String),
    Transport(TransportError),
    #[non_exhaustive]
    Api {
        status: StatusCode,
        headers: Box<HeaderMap>,
        body: String,
        truncated: bool,
        body_error: Option<TransportError>,
    },
    #[non_exhaustive]
    Body {
        status: StatusCode,
        headers: Box<HeaderMap>,
        received: usize,
        source: TransportError,
    },
    #[non_exhaustive]
    Decode {
        status: StatusCode,
        headers: Box<HeaderMap>,
        body: String,
        source: DecodeError,
    },
    #[non_exhaustive]
    ResponseTooLarge {
        limit: usize,
        status: StatusCode,
        headers: Box<HeaderMap>,
    },
    UnexpectedPage {
        requested: u32,
        returned: u32,
    },
    PageLimit {
        max_pages: u32,
    },
    Serialize(Arc<dyn Error + Send + Sync>),
}

Responses that fail keep their status and headers. Bodies may contain operational data, so neither Display nor Debug prints them, nor any response value quoted by a decoding error; read Error::body or DecodeError::inner deliberately.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Configuration(String)

InvalidRequest(String)

Transport(TransportError)

#[non_exhaustive]

Api

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

status: StatusCode

headers: Box<HeaderMap>

body: String

At most 16 KiB of the response body.

truncated: bool

The body was longer than the retained part.

body_error: Option<TransportError>

Reading the body failed after the status and headers arrived; body holds what was received.

#[non_exhaustive]

Body

A successful status and headers arrived, but reading the body failed. For a mutation this is evidence that Kibana accepted the request, not proof of its outcome; reconcile by reading the resource back.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

status: StatusCode

headers: Box<HeaderMap>

received: usize

Bytes received before the failure.

source: TransportError

#[non_exhaustive]

Decode

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

status: StatusCode

headers: Box<HeaderMap>

body: String

At most 16 KiB of the response body.

source: DecodeError

#[non_exhaustive]

ResponseTooLarge

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

limit: usize

status: StatusCode

headers: Box<HeaderMap>

UnexpectedPage

A page stream received a different page than it requested.

Fields

requested: u32

returned: u32

PageLimit

A bounded page stream read its maximum number of pages while more remained.

Fields

max_pages: u32

Serialize(Arc<dyn Error + Send + Sync>)

Implementations

impl Error

pub fn status(&self) -> Option<StatusCode>

The HTTP status of a response that arrived, including successful responses whose body could not be read or decoded.

pub fn headers(&self) -> Option<&HeaderMap>

The headers of a response that arrived.

pub fn body(&self) -> Option<&str>

The retained body excerpt for API or decode errors, limited to 16 KiB. Interrupted reads and size-limit errors retain context but no body excerpt.

pub fn transport(&self) -> Option<&TransportError>

The connection, timeout or streaming failure behind this error, whether it happened before a response arrived or while reading its body.

pub fn message(&self) -> Option<String>

The message field of a Kibana JSON error body, when present.

pub fn retry_after(&self) -> Option<Duration>

The Retry-After delay of an error response, when given in seconds. HTTP-date values are not parsed.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.