Enum ApiError 

#[non_exhaustive]
pub enum ApiError {
    InvalidBaseUrl {
        url: String,
        message: String,
    },
    Http(Error),
    Io(Error),
    Json(Error),
    InvalidInput {
        message: String,
    },
    Status {
        status: u16,
        message: String,
        body: Option<String>,
    },
    Api {
        status: Option<u16>,
        error: String,
        error_code: Option<i32>,
        description: String,
    },
}

Error returned by ApiClient HTTP calls.

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.

InvalidBaseUrl

Invalid Inline API base URL supplied to an API client builder.

Fields

url: String

Original URL value supplied by the caller.

message: String

Human-readable validation failure.

Http(Error)

A network, TLS, redirect, or HTTP client error from reqwest.

Io(Error)

Local file system error, currently used when reading upload inputs.

Json(Error)

JSON encoding or decoding error.

InvalidInput

SDK input validation error before sending a request.

Fields

message: String

Human-readable validation failure.

Status

Non-success HTTP status where the body could not be decoded as an Inline error.

Fields

status: u16

HTTP status code.

message: String

Human-readable HTTP status text.

body: Option<String>

Short normalized response-body preview, when available.

Api

Inline API error decoded from a structured response body.

Fields

status: Option<u16>

HTTP status code, when the error came from an HTTP response.

error: String

Stable server error name or fallback error label.

error_code: Option<i32>

Numeric server error code, when provided.

description: String

Human-readable error description.

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

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 From<Error> for ApiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(source: Error) -> Self

Converts to this type from the input type.