Enum WaiterError

#[non_exhaustive]
pub enum WaiterError<O, E> {
    ConstructionFailure(ConstructionFailure),
    ExceededMaxWait(ExceededMaxWait),
    FailureState(FailureState<O, E>),
    OperationFailed(OperationFailed<E>),
}

An error occurred while waiting.

This error type is useful for distinguishing between the max wait time being exceeded, or some other failure occurring.

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)

An error occurred during waiter initialization.

This can happen if the input/config is invalid.

ExceededMaxWait(ExceededMaxWait)

The maximum wait time was exceeded without completion.

FailureState(FailureState<O, E>)

Waiting ended in a failure state.

A failed waiter state can occur on a successful response from the server if, for example, that response indicates that the thing being waited for won’t succeed/finish.

A failure state error will only occur for successful or modeled error responses. Unmodeled error responses will never make it into this error case.

OperationFailed(OperationFailed<E>)

A polling operation failed while waiting.

This error will only occur for unmodeled errors. Modeled errors can potentially be handled by the waiter logic, and will therefore end up in WaiterError::FailureState.

Note: If retry is configured, this means that the operation failed after retrying the configured number of attempts.

Implementations

impl<O, E> WaiterError<O, E>

pub fn construction_failure(source: impl Into<BoxError>) -> Self

Construct a waiter construction failure with the given error source.

Trait Implementations

impl<O: Debug, E: Debug> Debug for WaiterError<O, E>

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

Formats the value using the given formatter.

impl<O, E> Display for WaiterError<O, E>

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

Formats the value using the given formatter.

impl<O, E> Error for WaiterError<O, E>

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

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<O, E> ProvideErrorMetadata for WaiterError<O, E>

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.