Enum aws_smithy_runtime_api::client::result::SdkError

source ·
#[non_exhaustive]
pub enum SdkError<E, R> { ConstructionFailure(ConstructionFailure), TimeoutError(TimeoutError), DispatchFailure(DispatchFailure), ResponseError(ResponseError<R>), ServiceError(ServiceError<E, R>), }
Expand description

Failed SDK Result

When logging an error from the SDK, it is recommended that you either wrap the error in DisplayErrorContext, use another error reporter library that visits the error’s cause/source chain, or call Error::source for more details about the underlying cause.

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

ConstructionFailure(ConstructionFailure)

The request failed during construction. It was not dispatched over the network.

§

TimeoutError(TimeoutError)

The request failed due to a timeout. The request MAY have been sent and received.

§

DispatchFailure(DispatchFailure)

The request failed during dispatch. An HTTP response was not received. The request MAY have been sent.

§

ResponseError(ResponseError<R>)

A response was received but it was not parseable according the the protocol (for example the server hung up without sending a complete response)

§

ServiceError(ServiceError<E, R>)

An error response was received from the service

Implementations§

source§

impl<E, R> SdkError<E, R>

source

pub fn construction_failure( source: impl Into<Box<dyn Error + Send + Sync>>, ) -> Self

Construct a SdkError for a construction failure

source

pub fn timeout_error(source: impl Into<Box<dyn Error + Send + Sync>>) -> Self

Construct a SdkError for a timeout

source

pub fn dispatch_failure(source: ConnectorError) -> Self

Construct a SdkError for a dispatch failure with a ConnectorError

source

pub fn response_error( source: impl Into<Box<dyn Error + Send + Sync>>, raw: R, ) -> Self

Construct a SdkError for a response error

source

pub fn service_error(source: E, raw: R) -> Self

Construct a SdkError for a service failure

source

pub fn into_service_error(self) -> E
where E: Error + Send + Sync + CreateUnhandledError + 'static, R: Debug + Send + Sync + 'static,

Returns the underlying service error E if there is one

If the SdkError is not a ServiceError (for example, the error is a network timeout), then it will be converted into an unhandled variant of E. This makes it easy to match on the service’s error response while simultaneously bubbling up transient failures. For example, handling the NoSuchKey error for S3’s GetObject operation may look as follows:

match sdk_err.into_service_error() {
    GetObjectError::NoSuchKey(_) => {
        // handle NoSuchKey
    }
    err @ _ => return Err(err),
}
source

pub fn as_service_error(&self) -> Option<&E>

Returns a reference underlying service error E if there is one

§Examples
if sdk_err.as_service_error().map(|e|e.is_not_found()) == Some(true) {
    println!("the object doesn't exist");
    // return None, or handle this error specifically
}
// ... handle other error cases, happy path, etc.
source

pub fn into_source(self) -> Result<Box<dyn Error + Send + Sync + 'static>, Self>
where E: Error + Send + Sync + 'static,

Converts this error into its error source.

If there is no error source, then Err(Self) is returned.

source

pub fn raw_response(&self) -> Option<&R>

Return a reference to this error’s raw response, if it contains one. Otherwise, return None.

source

pub fn map_service_error<E2>(self, map: impl FnOnce(E) -> E2) -> SdkError<E2, R>

Maps the service error type in SdkError::ServiceError

Trait Implementations§

source§

impl<E: Debug, R: Debug> Debug for SdkError<E, R>

source§

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

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

impl<E, R> Display for SdkError<E, R>

source§

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

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

impl<E, R> Error for SdkError<E, R>
where E: Error + 'static, R: Debug,

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<E, R> From<BuildError> for SdkError<E, R>

source§

fn from(value: BuildError) -> Self

Converts to this type from the input type.
source§

impl<E, R> ProvideErrorMetadata for SdkError<E, R>

source§

fn meta(&self) -> &ErrorMetadata

Returns error metadata, which includes the error code, message, request ID, and potentially additional information.
source§

fn code(&self) -> Option<&str>

Returns the error code if it’s available.
source§

fn message(&self) -> Option<&str>

Returns the error message, if there is one.

Auto Trait Implementations§

§

impl<E, R> Freeze for SdkError<E, R>
where R: Freeze, E: Freeze,

§

impl<E, R> !RefUnwindSafe for SdkError<E, R>

§

impl<E, R> Send for SdkError<E, R>
where R: Send, E: Send,

§

impl<E, R> Sync for SdkError<E, R>
where R: Sync, E: Sync,

§

impl<E, R> Unpin for SdkError<E, R>
where R: Unpin, E: Unpin,

§

impl<E, R> !UnwindSafe for SdkError<E, R>

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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

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

source§

default 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>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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