Enum SdkError 

pub enum SdkError {
    ApiResponse {
        body: Option<Value>,
        operation_id: String,
        schema_name: Option<&'static str>,
        status: u16,
    },
    MissingAuth,
    MissingParameter {
        location: &'static str,
        name: String,
        operation_id: String,
    },
    MissingRequestBody {
        operation_id: String,
    },
    UnexpectedStatus {
        expected: u16,
        actual: u16,
    },
    Decode(Error),
    InvalidUrl {
        base_url: String,
        path: String,
    },
    InvalidPathTemplate {
        operation_id: String,
        path_template: String,
    },
    UnknownOperation {
        operation_id: String,
    },
    Transport(TransportError),
}

Errors raised by the SDK execution layer.

Variants

ApiResponse

A documented API error payload was returned by the server.

Fields

body: Option<Value>

Decoded JSON body when the documented response payload is JSON.

operation_id: String

Operation identifier used for the request.

schema_name: Option<&'static str>

Schema name documented for the matched response payload.

status: u16

HTTP status code returned by the server.

MissingAuth

A secured request was attempted without configured credentials.

MissingParameter

A required path, query, or header parameter was not provided.

Fields

location: &'static str

Parameter location in the HTTP request.

name: String

Parameter name.

operation_id: String

Operation identifier used for the request.

MissingRequestBody

A required request body was omitted.

Fields

operation_id: String

Operation identifier used for the request.

UnexpectedStatus

The response status did not match what the caller expected.

Fields

expected: u16

Expected HTTP status code.

actual: u16

Actual HTTP status code.

Decode(Error)

The response body did not match the expected format.

InvalidUrl

The configured base URL or request path could not be resolved.

Fields

base_url: String

Base URL configured on the SDK.

path: String

Path provided by the SDK request.

InvalidPathTemplate

The operation path template still contained unresolved placeholders after encoding.

Fields

operation_id: String

Operation identifier used for the request.

path_template: String

Path template that could not be fully encoded.

UnknownOperation

No generated descriptor matched the requested operation ID.

Fields

operation_id: String

Operation identifier requested by the caller.

Transport(TransportError)

The underlying transport failed.

Trait Implementations

impl Debug for SdkError

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

Formats the value using the given formatter.

impl Display for SdkError

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

Formats the value using the given formatter.

impl Error for SdkError

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 SdkError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<SdkError> for CliError

fn from(source: SdkError) -> Self

Converts to this type from the input type.

impl From<TransportError> for SdkError

fn from(source: TransportError) -> Self

Converts to this type from the input type.