Skip to main content

Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error { Protocol(Error), InvalidStatusCodeWithDetails { status: StatusCode, body: String, headers: HeaderMap, }, StreamEnded, InvalidContentType(HeaderValue), Transient(BoxError), Permanent(BoxError), }
Expand description

Why an HTTP request failed: a protocol or header error, a non-success reply, or the transport’s own error, which says whether sending the same request again may work.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Protocol(Error)

The request could not be built.

§

InvalidStatusCodeWithDetails

Failed HTTP response preserving its status, body, and headers. Transport failures without a response use Self::Transient, Self::Permanent or a protocol variant.

Fields

§status: StatusCode

The non-success status.

§body: String

The raw response body.

§headers: HeaderMap

The failed response’s headers, verbatim.

§

StreamEnded

The response stream ended before it was done.

§

InvalidContentType(HeaderValue)

The response’s content type was not the one expected.

§

Transient(BoxError)

The transport failed without a reply, and sending the same request again may work: a refused or reset connection, a timeout, a body cut short.

§

Permanent(BoxError)

The transport failed without a reply, and sending the same request again fails the same way: a request it cannot send as it is, missing credentials, a client that could not be built.

Implementations§

Source§

impl Error

Source

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

Preserved HTTP failure status, or None for other error variants.

Source

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

The response body this error preserved, when it has one. Companion to Self::non_success_status and Self::non_success_headers.

Source

pub fn non_success_with_details( status: StatusCode, headers: HeaderMap, body: String, ) -> Self

Constructs a failure from its HTTP status, headers, and body without validating that the status is non-successful.

Source

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

Returns the failed response’s headers, when this error preserved them. Don’t parse Retry-After from them by hand: a provider error carries these headers into rig-core’s ErrorReport, whose retry_after reads every form of the wait a provider asks for.

Returns None for a response-less failure: every non-success error carries its headers.

Source§

impl Error

Source

pub fn is_transient(&self) -> bool

Whether sending the same request again may pass: after StreamEnded and what the transport called Error::Transient it may, a status decides through retryable_status, and after anything else (protocol, header and content-type errors, Error::Permanent) it does not. A retry may repeat a request the server already processed.

Source

pub fn transient(error: impl Into<BoxError>) -> Self

A transport’s own error after which sending the same request again may work, such as a reset connection or a timeout. A non-success reply goes through Error::non_success_with_details instead, so its status decides.

Source

pub fn permanent(error: impl Into<BoxError>) -> Self

A transport’s own error that sending the same request again meets again, such as a request it cannot send or a client it could not build.

Trait Implementations§

Source§

impl Debug for Error

Source§

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

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

impl Display for Error

Source§

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

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

impl Error for Error

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

Replaced by Error::source.
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
Source§

impl From<Error> for Error

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !Freeze for Error

§

impl !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Forget for Error

§

impl Move for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

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, 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> 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> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,