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
impl Error
Sourcepub fn new(kind: ErrorKind, message: impl Into<String>) -> Self
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"));Sourcepub fn with_status(self, status: u16) -> Self
pub fn with_status(self, status: u16) -> Self
Sets the HTTP status.
Sourcepub fn with_error_type(self, error_type: impl Into<String>) -> Self
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.
Sourcepub fn with_request_id(self, request_id: Option<String>) -> Self
pub fn with_request_id(self, request_id: Option<String>) -> Self
Sets the x-typesafe-request-id.
Sourcepub const fn with_retry_after(self, retry_after: Option<Duration>) -> Self
pub const fn with_retry_after(self, retry_after: Option<Duration>) -> Self
Sets the delay the server asked for.
Sourcepub const fn with_attempts(self, attempts: u32) -> Self
pub const fn with_attempts(self, attempts: u32) -> Self
Sets how many attempts were made.
Sourcepub fn error_type(&self) -> Option<&str>
pub fn error_type(&self) -> Option<&str>
The API’s machine-readable error type, such as authentication_error, when it sent one.
Sourcepub fn request_id(&self) -> Option<&str>
pub fn request_id(&self) -> Option<&str>
The x-typesafe-request-id of the failed attempt, when the server sent one.
Sourcepub const fn retry_after(&self) -> Option<Duration>
pub const fn retry_after(&self) -> Option<Duration>
The delay the server asked for before trying again, when it sent one.
Sourcepub const fn attempts(&self) -> u32
pub const fn attempts(&self) -> u32
How many attempts were made, including the first. 0 when no request was sent.
Sourcepub fn is_retryable(&self) -> bool
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 Error for Error
impl Error for Error
Source§fn source(&self) -> Option<&(dyn StdError + 'static)>
fn source(&self) -> Option<&(dyn StdError + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()