Struct ApiError 

#[non_exhaustive]
pub struct ApiError {
    pub status: u16,
    pub error_code: ErrorCode,
    pub message: String,
    pub retry_after: Option<u64>,
}

Structured information from a non-2xx Snippe response.

The Snippe response envelope on error looks like:

{
  "status": "error",
  "code": 400,
  "error_code": "validation_error",
  "message": "amount is required"
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

status: u16

HTTP status code.

error_code: ErrorCode

Stable machine-readable Snippe error code (e.g. validation_error).

message: String

Human-readable error message.

retry_after: Option<u64>

Value of the X-Ratelimit-Reset header in seconds, if the response was a 429 rate limit.

Implementations

impl ApiError

pub fn is_retryable(&self) -> bool

True if this error is worth retrying with backoff.

• 5xx and the PAY_001 code are retryable (transient processor / server issues).
• 429 rate_limit_exceeded is retryable, but you should wait until Self::retry_after seconds before the next attempt.
• All 4xx validation, auth, and conflict errors are not retryable.

pub fn is_unauthorized(&self) -> bool

Convenience: true if this is a 401 unauthorized.

pub fn is_idempotency_conflict(&self) -> bool

Convenience: true if this is a 422 idempotency-conflict error.

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.