Skip to main content

Error

Enum Error 

Source
pub enum Error<E = Infallible> {
    Validation {
        field: String,
        message: String,
    },
    Configuration(String),
    Transport(E),
    Timeout {
        timeout: Duration,
    },
    Decode {
        status: StatusCode,
        request_id: Option<String>,
        headers: Box<HeaderMap>,
        body: Vec<u8>,
        source: Error,
    },
    Api {
        status: StatusCode,
        request_id: Option<String>,
        headers: Box<HeaderMap>,
        body: Vec<u8>,
        retry_after: Option<Duration>,
        attempts: u64,
    },
    IncompleteEvaluation,
}
Expand description

Errors returned while configuring or using a client.

Variants§

§

Validation

The request violates a documented API constraint.

Fields

§field: String

Field containing the invalid value.

§message: String

Description of the constraint.

§

Configuration(String)

The client configuration is invalid.

§

Transport(E)

The HTTP exchange failed before a response was available.

§

Timeout

The configured per-attempt timeout elapsed.

Fields

§timeout: Duration

Timeout configured for each attempt.

§

Decode

A successful HTTP response could not be decoded.

Fields

§status: StatusCode

HTTP status returned by the API.

§request_id: Option<String>

Value of the request id response header, when present.

§headers: Box<HeaderMap>

HTTP response headers.

§body: Vec<u8>

Raw response bytes.

§source: Error

JSON decoding error.

§

Api

The API returned a non-success status.

Fields

§status: StatusCode

HTTP status returned by the API.

§request_id: Option<String>

Value of the request id response header, when present.

§headers: Box<HeaderMap>

HTTP response headers.

§body: Vec<u8>

Raw response bytes, including non-JSON bodies.

§retry_after: Option<Duration>

Requested server retry delay, when supplied and valid.

§attempts: u64

Total attempts made, including the initial request.

§

IncompleteEvaluation

An application-supplied event sequence ended before a terminal event.

Implementations§

Source§

impl<E> Error<E>

Source

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

Returns the associated HTTP status, when a response was received.

Source

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

Returns the TypeSafe request id, when one was received.

Source

pub fn body(&self) -> Option<&[u8]>

Returns raw response bytes for API and decode failures.

Source

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

Returns response headers for API and decode failures.

Source§

impl Error<Infallible>

Source

pub fn with_transport<E>(self) -> Error<E>
where E: Error + Send + Sync + 'static,

Converts a backend-neutral error to one carrying a concrete transport error type.

This is useful in custom client implementations after calling Request::validate.

Trait Implementations§

Source§

impl<E: Debug> Debug for Error<E>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<E> Display for Error<E>
where E: Display,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<E> Error for Error<E>
where E: Error + 'static, Self: Debug + Display,

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more

Auto Trait Implementations§

§

impl<E = !> !RefUnwindSafe for Error<E>

§

impl<E = !> !UnwindSafe for Error<E>

§

impl<E> Forget for Error<E>

§

impl<E> Freeze for Error<E>
where E: Freeze,

§

impl<E> Send for Error<E>
where E: Send,

§

impl<E> Sync for Error<E>
where E: Sync,

§

impl<E> Unpin for Error<E>
where E: Unpin,

§

impl<E> UnsafeUnpin for Error<E>
where E: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more