Skip to main content

Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error { Config(Box<ErrorContext>), Authentication(Box<ErrorContext>), PermissionDenied(Box<ErrorContext>), NotFound(Box<ErrorContext>), Conflict(Box<ErrorContext>), RateLimited(Box<ErrorContext>), Validation(Box<ErrorContext>), Unavailable(Box<ErrorContext>), Timeout(Box<ErrorContext>), Unsupported(Box<ErrorContext>), Cancelled(Box<ErrorContext>), }
Expand description

The SDK error. Match on the variant or use Error::code.

Messages never contain secrets, tokens, request bodies or unfiltered response bodies.

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.
§

Config(Box<ErrorContext>)

CONFIG: invalid or missing configuration.

§

Authentication(Box<ErrorContext>)

AUTHENTICATION: HTTP 401.

§

PermissionDenied(Box<ErrorContext>)

PERMISSION_DENIED: HTTP 403.

§

NotFound(Box<ErrorContext>)

NOT_FOUND: HTTP 404 or a missing record.

§

Conflict(Box<ErrorContext>)

CONFLICT: HTTP 409, 412 or a CAS mismatch.

§

RateLimited(Box<ErrorContext>)

RATE_LIMITED: HTTP 429 (see Error::retry_after).

§

Validation(Box<ErrorContext>)

VALIDATION: rejected input.

§

Unavailable(Box<ErrorContext>)

UNAVAILABLE: network error or HTTP 500/502/503.

§

Timeout(Box<ErrorContext>)

TIMEOUT: a deadline was exceeded.

§

Unsupported(Box<ErrorContext>)

UNSUPPORTED: capability not offered by the service.

§

Cancelled(Box<ErrorContext>)

CANCELLED: the caller cancelled.

Implementations§

Source§

impl Error

Source

pub fn new(code: ErrorCode, message: impl Into<String>) -> Self

Creates an error with the given code; retryable defaults per code.

Source

pub fn from_status(status: u16, message: impl Into<String>) -> Self

Error for an HTTP status (SPEC §2.1 mapping); non-error statuses map to UNAVAILABLE.

Source

pub fn config(message: impl Into<String>) -> Self

CONFIG error.

Source

pub fn validation(message: impl Into<String>) -> Self

VALIDATION error.

Source

pub fn not_found(message: impl Into<String>) -> Self

NOT_FOUND error.

Source

pub fn conflict(message: impl Into<String>) -> Self

CONFLICT error.

Source

pub fn timeout(message: impl Into<String>) -> Self

TIMEOUT error.

Source

pub fn unavailable(message: impl Into<String>) -> Self

UNAVAILABLE error.

Source

pub fn unsupported(message: impl Into<String>) -> Self

UNSUPPORTED error.

Source

pub fn cancelled(message: impl Into<String>) -> Self

CANCELLED error.

Source

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

Sets the HTTP status.

Source

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

Sets the vendor request id.

Source

pub fn with_retryable(self, retryable: bool) -> Self

Overrides whether the error is retryable.

Source

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

Sets the server-requested wait before a retry.

Source

pub fn with_source(self, source: impl Error + Send + Sync + 'static) -> Self

Sets the underlying cause (it must not expose secrets).

Source

pub fn with_message(self, message: impl Into<String>) -> Self

Replaces the message.

Source

pub fn code(&self) -> ErrorCode

Canonical code.

Source

pub fn message(&self) -> &str

Human-readable message (redacted).

Source

pub fn http_status(&self) -> Option<u16>

HTTP status when the error came from a response.

Source

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

Vendor request id when the response carried one.

Source

pub fn is_retryable(&self) -> bool

Whether retrying the same call may succeed.

Source

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

Server-requested wait (Retry-After) when known.

Source

pub fn is(&self, code: ErrorCode) -> bool

Whether this error has the given code.

Source

pub fn cause(&self) -> Option<&(dyn Error + Send + Sync + 'static)>

The underlying cause, when any.

Trait Implementations§

Source§

impl Clone for Error

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
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, f: &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

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(err: Error) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Forget for Error

§

impl Freeze 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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