Struct S3Error 

pub struct S3Error { /* private fields */ }

A structured S3 client error.

Formatting an error never prints its underlying source or cleanup error. Source errors are retained only as redacted type markers, preventing URLs, headers, or response data from escaping through an otherwise innocent log statement.

Implementations

impl S3Error

pub fn new( category: ErrorCategory, message: impl Into<String>, retry: RetryClassification, ) -> Self

Creates an error with a category, safe message, and retry classification.

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

Creates a configuration error.

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

Creates an unsupported-operation error.

pub fn transport<E>(source: E) -> Self

where E: Error + Send + Sync + 'static,

Creates a transport error while retaining only a redacted source marker.

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

Creates a timeout error.

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

Creates an invalid-response error.

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

Creates an integrity error.

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

Creates a cancellation error.

pub fn with_source<E>(self, _source: E) -> Self

where E: Error + Send + Sync + 'static,

Retains the source error’s type while discarding potentially sensitive text.

pub fn category(&self) -> ErrorCategory

Returns the broad error category.

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

Returns the S3 error code, when supplied by the service.

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

Returns the numeric HTTP response status, when a response was received.

pub fn message(&self) -> &str

Returns the safe, caller-facing error message.

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

Returns the S3 request identifier, when supplied by the service.

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

Returns the S3 host identifier, when supplied by the service.

pub fn retry_classification(&self) -> RetryClassification

Returns the retry classification.

pub fn timeout_phase(&self) -> Option<TimeoutPhase>

Returns the timeout phase, when this is a timeout error.

pub fn server_time(&self) -> Option<OffsetDateTime>

Returns the server’s reported time for a clock-skew failure.

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

Returns server_time - local_time for a clock-skew failure.

pub fn cleanup_failure(&self) -> Option<&Self>

Returns the cleanup error attached to a primary failure.

pub fn attempts(&self) -> u32

Returns the number of completed request attempts represented by this error.

pub fn retry_stop_reason(&self) -> Option<RetryStopReason>

Returns why the client did not make another retry attempt.

Trait Implementations

impl Debug for S3Error

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

Formats the value using the given formatter.

impl Display for S3Error

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

Formats the value using the given formatter.

impl Error for S3Error

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.