Enum Error 

pub enum Error {
    Transport(Error),
    Api {
        status: u16,
        code: Option<ErrorCode>,
        message: String,
        request_id: Option<String>,
        retry_after: Option<Duration>,
        details: Option<Value>,
    },
    BudgetExceeded {
        message: String,
        affected_scopes: Vec<String>,
        retry_after: Option<Duration>,
        request_id: Option<String>,
    },
    Deserialization(Error),
    Config(String),
    Validation(String),
}

The error type for all Cycles client operations.

Variants

Transport(Error)

HTTP transport error (network failure, timeout, DNS, etc.).

Api

The server returned an error response.

Fields

status: u16

HTTP status code.

code: Option<ErrorCode>

Parsed error code from the response body.

message: String

Human-readable error message.

request_id: Option<String>

Server-assigned request ID.

retry_after: Option<Duration>

Suggested retry delay.

details: Option<Value>

Additional error details.

BudgetExceeded

Budget is insufficient for the requested operation (HTTP 409).

Fields

message: String

Human-readable error message.

affected_scopes: Vec<String>

Scopes that are over budget.

retry_after: Option<Duration>

Suggested retry delay.

request_id: Option<String>

Server-assigned request ID.

Deserialization(Error)

Failed to deserialize the response body.

Config(String)

Invalid client configuration.

Validation(String)

Invalid request parameters (caught before sending).

Implementations

impl Error

pub fn is_retryable(&self) -> bool

Returns true if the error is retryable.

Transport errors and server errors (5xx) are generally retryable. Budget exceeded errors are not retryable unless the server suggests a retry delay.

pub fn is_budget_exceeded(&self) -> bool

Returns true if this is a budget exceeded error.

pub fn retry_after(&self) -> Option<Duration>

Returns the suggested retry delay, if any.

pub fn request_id(&self) -> Option<&str>

Returns the server-assigned request ID, if available.

pub fn error_code(&self) -> Option<ErrorCode>

Returns the error code, if available.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(err: Error) -> Self

Converts to this type from the input type.