Enum SdkError

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

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)

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

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

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

Construct a SdkError for a construction failure

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

Construct a SdkError for a timeout

pub fn dispatch_failure(source: ConnectorError) -> Self

Construct a SdkError for a dispatch failure with a ConnectorError

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

Construct a SdkError for a response error

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

Construct a SdkError for a service failure

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),
}

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.

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.

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

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

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

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

where E: Error + 'static, R: Debug,

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

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.

impl<E, R> From<BuildError> for SdkError<E, R>

fn from(value: BuildError) -> Self

Converts to this type from the input type.

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

where E: ProvideErrorMetadata,

fn meta(&self) -> &ErrorMetadata

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

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

Returns the error code if it’s available.

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

Returns the error message, if there is one.