Skip to main content

Error

Struct Error 

Source
pub struct Error { /* private fields */ }
Expand description

An error from a Transport.

Every error carries its ErrorKind and a message, plus whatever the server supplied: the HTTP status, the API’s own error_type, and the x-typesafe-request-id to quote when asking TypeSafe for help. Nothing in an error ever contains the API key or a request’s state.

use jev_client::ErrorKind;

if let Err(error) = transport.evaluate(&request).await {
    match error.kind() {
        ErrorKind::Authentication => eprintln!("check your API key"),
        kind if kind.is_retryable() => eprintln!("try again later: {error}"),
        _ => eprintln!("{error}"),
    }
}

Implementations§

Source§

impl Error

Source

pub fn new(kind: ErrorKind, message: impl Into<String>) -> Self

An error of the given kind.

HttpTransport builds its own errors; this constructor and the with_* methods exist so that a fake Transport in a test can return the same errors the real one would.

use jev_client::{Error, ErrorKind};

let error = Error::new(ErrorKind::RateLimit, "Slow down.")
    .with_status(429)
    .with_error_type("rate_limit_error")
    .with_request_id(Some("req_123".to_owned()));

assert!(error.is_retryable());
assert_eq!(error.request_id(), Some("req_123"));
Source

pub fn with_status(self, status: u16) -> Self

Sets the HTTP status.

Source

pub fn with_error_type(self, error_type: impl Into<String>) -> Self

Sets the API’s machine-readable error type, such as rate_limit_error.

Source

pub fn with_request_id(self, request_id: Option<String>) -> Self

Sets the x-typesafe-request-id.

Source

pub const fn with_retry_after(self, retry_after: Option<Duration>) -> Self

Sets the delay the server asked for.

Source

pub const fn with_attempts(self, attempts: u32) -> Self

Sets how many attempts were made.

Source

pub const fn kind(&self) -> ErrorKind

The category of the error.

Source

pub fn message(&self) -> &str

The message: the API’s own, when it sent one.

Source

pub const fn status(&self) -> Option<u16>

The HTTP status, when the server answered.

Source

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

The API’s machine-readable error type, such as authentication_error, when it sent one.

Source

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

The x-typesafe-request-id of the failed attempt, when the server sent one.

Source

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

The delay the server asked for before trying again, when it sent one.

Source

pub const fn attempts(&self) -> u32

How many attempts were made, including the first. 0 when no request was sent.

Source

pub fn is_retryable(&self) -> bool

Returns true when trying again later can reasonably succeed. See ErrorKind::is_retryable; a 408 also counts.

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 StdError + '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 !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Freeze 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> 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