Enum ApiClientError

pub enum ApiClientError {
    ReqwestError(Error),
    UrlError(ParseError),
    HeadersError(Error),
    HttpError(Error),
    InvalidHeaderName(InvalidHeaderName),
    InvalidHeaderValue(InvalidHeaderValue),
    JsonValueError(Error),
    QuerySerializationError(Error),
    AuthenticationError(AuthenticationError),
    CallResultRequired,
    InvalidBasePath {
        error: String,
    },
    JsonError {
        path: String,
        error: Error,
        body: String,
    },
    UnsupportedJsonOutput {
        output: Output,
        name: &'static str,
    },
    UnsupportedTextOutput {
        output: Output,
    },
    UnsupportedBytesOutput {
        output: Output,
    },
    PathUnresolved {
        path: String,
        missings: Vec<String>,
    },
    UnsupportedQueryParameterValue {
        value: Value,
    },
    UnsupportedParameterValue {
        message: String,
        value: Value,
    },
    MissingOperation {
        id: String,
    },
    ServerFailure {
        raw_body: String,
    },
    SerializationError {
        message: String,
    },
    UnexpectedStatusCode {
        status_code: u16,
        body: String,
    },
}

Errors that can occur when using the ApiClient.

This enum covers all possible error conditions from network issues to data validation failures. All variants implement std::error::Error and provide detailed context for debugging.

Variants

ReqwestError(Error)

HTTP client error from the underlying reqwest library.

Occurs when network requests fail, timeouts occur, or connection issues arise.

UrlError(ParseError)

URL parsing error when constructing request URLs.

Occurs when the base URL or path parameters create an invalid URL.

HeadersError(Error)

HTTP header processing error.

Occurs when header values cannot be processed or are malformed.

HttpError(Error)

HTTP protocol error from the http crate.

Occurs when HTTP protocol constraints are violated.

InvalidHeaderName(InvalidHeaderName)

Invalid HTTP header name.

Occurs when attempting to create headers with invalid names.

InvalidHeaderValue(InvalidHeaderValue)

Invalid HTTP header value.

Occurs when header values contain invalid characters.

JsonValueError(Error)

JSON serialization/deserialization error.

Occurs when working with JSON request bodies or responses.

QuerySerializationError(Error)

Query parameter serialization error.

Occurs when converting structures to URL query strings.

AuthenticationError(AuthenticationError)

Authentication processing error.

Occurs when authentication credentials cannot be processed or are invalid.

CallResultRequired

No call result available for operation.

Occurs when attempting to access response data before making a request.

InvalidBasePath

Invalid base path configuration.

Occurs when the provided base path cannot be used for URL construction.

Fields

error: String

Description of why the base path is invalid.

JsonError

JSON response deserialization failure.

Occurs when the response body cannot be parsed as the expected JSON structure.

Fields

path: String

The request path where the error occurred.

error: Error

The underlying JSON parsing error.

body: String

The response body that failed to parse.

UnsupportedJsonOutput

Response output type is incompatible with JSON deserialization.

Occurs when attempting to parse non-JSON responses as JSON.

Fields

output: Output

The actual response output received.

name: &'static str

Name of the operation that failed.

UnsupportedTextOutput

Response output type is incompatible with text extraction.

Occurs when attempting to extract text from binary or empty responses.

Fields

output: Output

The actual response output received.

UnsupportedBytesOutput

Response output type is incompatible with byte extraction.

Occurs when attempting to extract bytes from empty responses.

Fields

output: Output

The actual response output received.

PathUnresolved

Path template contains unresolved parameters.

Occurs when path parameters are missing for templated URLs.

Fields

path: String

The path template that couldn’t be resolved.

missings: Vec<String>

List of missing parameter names.

UnsupportedQueryParameterValue

Query parameter value type is not supported.

Occurs when attempting to use complex objects as query parameters.

Fields

value: Value

The unsupported value that was provided.

UnsupportedParameterValue

Parameter value cannot be converted to the required format.

Occurs when parameter values are incompatible with their target type.

Fields

message: String

Specific error message describing the conversion failure.

value: Value

The value that failed to convert.

MissingOperation

OpenAPI operation not found in the specification.

Occurs when referencing operations that don’t exist in the collected spec.

Fields

id: String

The operation ID that was not found.

ServerFailure

Server returned an internal error (HTTP 500).

Occurs when the server encounters an internal error during request processing.

Fields

raw_body: String

The response body containing error details.

SerializationError

Data serialization failed.

Occurs when request data cannot be converted to the required format.

Fields

message: String

Description of the serialization failure.

UnexpectedStatusCode

Server returned an unexpected HTTP status code.

Occurs when the response status code doesn’t match expected values.

Fields

status_code: u16

The unexpected HTTP status code received.

body: String

The response body for debugging.

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, __derive_more_f: &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 From<ApiClientError> for TestAppError

fn from(value: ApiClientError) -> Self

Converts to this type from the input type.

impl From<AuthenticationError> for ApiClientError

fn from(value: AuthenticationError) -> Self

Converts to this type from the input type.

impl From<Error> for ApiClientError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiClientError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiClientError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiClientError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiClientError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<InvalidHeaderName> for ApiClientError

fn from(value: InvalidHeaderName) -> Self

Converts to this type from the input type.

impl From<InvalidHeaderValue> for ApiClientError

fn from(value: InvalidHeaderValue) -> Self

Converts to this type from the input type.

impl From<ParseError> for ApiClientError

fn from(value: ParseError) -> Self

Converts to this type from the input type.

impl From<String> for ApiClientError

fn from(value: String) -> Self

Converts to this type from the input type.