Enum ApiAttemptError 

#[non_exhaustive]
pub enum ApiAttemptError {
    ClientSetup {
        transient: bool,
        source: Box<dyn Error + Send + Sync>,
    },
    UnderlayDiscovery {
        transient: bool,
        source: Box<dyn Error + Send + Sync>,
    },
}

Error for a single endhost API connection attempt.

The underlying cause is available through std::error::Error::source; the concrete source type is intentionally not exposed. Use is_transient to decide whether a retry may help.

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.

ClientSetup

The API client could not be instantiated (e.g. invalid URL scheme).

Fields

transient: bool

Whether the failure is transient and a retry may help.

source: Box<dyn Error + Send + Sync>

The underlying cause.

UnderlayDiscovery

Underlay discovery against the API failed (e.g. server unreachable).

Fields

transient: bool

Whether the failure is transient and a retry may help.

source: Box<dyn Error + Send + Sync>

The underlying cause.

Implementations

impl ApiAttemptError

pub fn is_transient(&self) -> bool

Returns whether the failure is transient and a retry may help.

Trait Implementations

impl Debug for ApiAttemptError

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

Formats the value using the given formatter.

impl Display for ApiAttemptError

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

Formats the value using the given formatter.

impl Error for ApiAttemptError

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.