Enum ApiClientError 

#[non_exhaustive]
pub enum ApiClientError {
    Auth(AuthError),
    ClientWithEndpoint {
        endpoint: String,
        source: NetworkError,
    },
    Client {
        source: NetworkError,
    },
    Http(Error),
    Body(BodyError),
    DecodeError(DecodeError),
    Conversion(ConversionError),
    ProtoError(ProtoError),
    InvalidUri(InvalidUri),
    Expired(Expired),
    Other(Box<dyn RetryableError>),
    OtherUnretryable(BoxDynError),
    WritesDisabled,
}

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.

Auth(AuthError)

ClientWithEndpoint

The client encountered an error.

Fields

endpoint: String

source: NetworkError

The client error.

Client

The transport failed. Retryability follows the source.

Fields

source: NetworkError

Http(Error)

The HTTP request is invalid. Not retryable.

Body(BodyError)

The request body is invalid. Not retryable.

DecodeError(DecodeError)

The response cannot be decoded. Not retryable.

Conversion(ConversionError)

A protocol conversion failed. Not retryable.

ProtoError(ProtoError)

A protocol operation failed. Not retryable.

InvalidUri(InvalidUri)

The URI is invalid. Not retryable.

Expired(Expired)

The request expired. Retryable.

Other(Box<dyn RetryableError>)

A client operation failed. Retryability follows the source.

OtherUnretryable(BoxDynError)

A client operation failed. Not retryable.

WritesDisabled

Writes are disabled. Not retryable.

Implementations

impl ApiClientError

pub fn is_locked_out(&self) -> bool

True while an authentication cool-down runs. #[error(transparent)] forwards Display but not source(), so the inner AuthError cannot be reached by walking the chain. Match the variant instead.

impl ApiClientError

pub fn new(endpoint: ApiEndpoint, source: impl RetryableError + 'static) -> Self

pub fn endpoint(self, endpoint: impl ToString) -> Self

add an endpoint to a ApiError::Client error

pub fn client(client: impl RetryableError + 'static) -> Self

pub fn network_error(&self) -> Option<&NetworkError>

Try to pull a NetworkError out of this error enum. returns None if there’s no match

impl ApiClientError

pub fn other<R: RetryableError + 'static>(e: R) -> Self

Trait Implementations

impl Debug for ApiClientError

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

Formats the value using the given formatter.

impl Display for ApiClientError

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

Formats the value using the given formatter.

impl Error for ApiClientError

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 ErrorCode for ApiClientError

fn error_code(&self) -> &'static str

Returns the unique error code for this error.

impl From<AuthError> for ApiClientError

fn from(source: AuthError) -> Self

Converts to this type from the input type.

impl From<BodyError> for ApiClientError

fn from(source: BodyError) -> Self

Converts to this type from the input type.

impl From<ConversionError> for ApiClientError

fn from(source: ConversionError) -> Self

Converts to this type from the input type.

impl From<DecodeError> for ApiClientError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<Error> for ApiClientError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Expired> for ApiClientError

fn from(source: Expired) -> Self

Converts to this type from the input type.

impl From<Infallible> for ApiClientError

fn from(_v: Infallible) -> ApiClientError

Converts to this type from the input type.

impl From<InvalidUri> for ApiClientError

fn from(source: InvalidUri) -> Self

Converts to this type from the input type.

impl From<ProtoError> for ApiClientError

fn from(source: ProtoError) -> Self

Converts to this type from the input type.

impl RetryableError for ApiClientError

fn is_retryable(&self) -> bool