Struct ApiError 

pub struct ApiError { /* private fields */ }

A structured API error decoded from the response envelope.

Branch on ApiError::kind (a stable ErrorCode); never pattern-match the human-readable ApiError::message, which may change between releases.

Implementations

impl ApiError

pub fn status(&self) -> u16

HTTP status code that carried this error.

pub fn code(&self) -> &ErrorCode

The stable error code. Alias for ApiError::kind.

pub fn kind(&self) -> &ErrorCode

The stable error code (the “kind” of API error).

pub fn message(&self) -> &str

Human-readable message. Log it; do not pattern-match it.

pub fn details(&self) -> Option<&Value>

Optional structured error.details payload as raw JSON.

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

The support-facing request_id (req_…), from the envelope or the X-Request-ID response header.

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

A honored Retry-After value, if the server sent one.

pub fn balance(&self) -> Option<i64>

For insufficient_credits: the caller’s current balance, if present.

pub fn required(&self) -> Option<i64>

For insufficient_credits: the credits required, if present.

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

For rate_limited: the reason discriminator (rate_limit_per_min | max_concurrent_requests | sb_runs_per_month).

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

For account_deletion_pending: the scheduled deletion timestamp.

pub fn is_unauthorized(&self) -> bool

True for unauthorized.

pub fn is_insufficient_credits(&self) -> bool

True for insufficient_credits.

pub fn is_rate_limited(&self) -> bool

True for rate_limited.

pub fn is_not_found(&self) -> bool

True for not_found.

pub fn is_validation_failed(&self) -> bool

True for validation_failed.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

fn from(source: ApiError) -> Self

Converts to this type from the input type.