Enum SdkError 

#[non_exhaustive]
pub enum SdkError {
    Api {
        status: u16,
        body: ApiErrorResponse,
    },
    Http {
        status: u16,
        message: String,
    },
    Auth(String),
    Token(TokenFormatError),
    Transport(String),
    Deserialize(String),
    Config(String),
    Serialize(String),
    ResourceNotFound {
        resource_type: &'static str,
        name: String,
    },
    AmbiguousResource {
        resource_type: &'static str,
        name: String,
        matches: Vec<Value>,
        match_count: usize,
    },
    Other(Error),
}

Exhaustive error returned by the high-level client.

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.

Api

The API returned a non-2xx response with a JSON ApiErrorResponse body.

Fields

status: u16

HTTP status code (e.g. 400, 404, 500).

body: ApiErrorResponse

Parsed error envelope.

Http

The API returned a non-2xx response whose body was not parseable JSON.

Fields

status: u16

message: String

Auth(String)

Authentication failed: missing, malformed, or rejected token.

Token(TokenFormatError)

Token parsing failed before any request was sent.

Transport(String)

Transport-level failure (DNS, TLS, connection reset, timeout…).

Deserialize(String)

Server reply could not be decoded (unexpected shape, invalid JSON).

Config(String)

Invalid SDK configuration (base URL missing, conflicting options, …).

Serialize(String)

The caller-provided data could not be serialized into a request body.

ResourceNotFound

No resource matched the requested localized name.

Fields

resource_type: &'static str

Resource kind (e.g. "integration", "portal").

name: String

Name needle passed to get_by_name.

AmbiguousResource

Multiple resources matched the same localized name.

Fields

resource_type: &'static str

Resource kind (e.g. "integration", "portal").

name: String

Name needle passed to get_by_name.

matches: Vec<Value>

All matching resource objects (include id for disambiguation).

match_count: usize

Number of matches (convenience for bindings).

Other(Error)

Catch-all for anything else; always prefer a more specific variant.

Implementations

impl SdkError

pub fn is_retryable(&self) -> bool

true iff the error is safe to retry as-is.

pub fn status(&self) -> Option<u16>

HTTP status when the error carries one, else None.

Trait Implementations

impl Debug for SdkError

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

Formats the value using the given formatter.

impl Display for SdkError

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

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) -> SdkError

Converts to this type from the input type.

impl From<Error> for SdkError

fn from(value: Error) -> SdkError

Converts to this type from the input type.

impl From<Error> for SdkError

fn from(value: Error) -> SdkError

Converts to this type from the input type.

impl From<Error> for SdkError

fn from(value: Error) -> SdkError

Converts to this type from the input type.

impl From<TokenFormatError> for SdkError

fn from(source: TokenFormatError) -> SdkError

Converts to this type from the input type.