Enum ZaiError 

#[non_exhaustive]
pub enum ZaiError {
    HttpError {
        status: u16,
        message: String,
    },
    AuthError {
        code: u16,
        message: String,
    },
    AccountError {
        code: u16,
        message: String,
    },
    ApiError {
        code: u16,
        message: String,
    },
    RateLimitError {
        code: u16,
        message: String,
    },
    ContentPolicyError {
        code: u16,
        message: String,
    },
    FileError {
        code: u16,
        message: String,
    },
    NetworkError(Arc<Error>),
    JsonError(Arc<Error>),
    RealtimeError(Arc<RealtimeErrorKind>),
    RealtimeAuthError(String),
    Unknown {
        code: u16,
        message: String,
    },
}

Main error type for the ZAI-RS SDK

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.

HttpError

HTTP status errors

Fields

status: u16

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

message: String

Human-readable error message returned with the response.

AuthError

Authentication and authorization errors

Fields

code: u16

Zhipu AI authentication/authorization business error code.

message: String

Human-readable error message.

AccountError

Account-related errors

Fields

code: u16

Zhipu AI account business error code (1110–1121, excluding quota/billing code 1113).

message: String

Human-readable error message.

ApiError

API call errors

Fields

code: u16

Zhipu AI business error code (1200–1234 or 1261) or a reserved SDK code from codes (9000–9999). Business codes 1200, 1230, and 1234 are categorized as server failures.

message: String

Human-readable error message.

RateLimitError

Rate limiting and quota errors

Fields

code: u16

Zhipu AI rate-limit, quota, or billing business error code.

message: String

Human-readable error message.

ContentPolicyError

Content policy errors

Fields

code: u16

Zhipu AI business error code 1301 for policy blocks or unsafe-content violations.

message: String

Human-readable error message.

FileError

File processing errors

Fields

code: u16

Zhipu AI business error code (1400–1499) or a reserved SDK file code from codes.

message: String

Human-readable error message.

NetworkError(Arc<Error>)

Network/IO errors (wrapped in Arc for Clone support). The underlying reqwest::Error is exposed as the Error::source.

JsonError(Arc<Error>)

JSON parsing errors (wrapped in Arc for Clone support). The underlying serde_json::Error is exposed as the Error::source.

RealtimeError(Arc<RealtimeErrorKind>)

Realtime (WebSocket) transport errors — wrapped in Arc so the variant stays Clone-able. See RealtimeErrorKind for the breakdown. The kind is exposed as the Error::source.

RealtimeAuthError(String)

Realtime authentication / JWT errors (bad API-key shape, signing failure, token rejected during the WebSocket handshake).

Unknown

Other errors

Fields

code: u16

Numeric code — either an unmapped business code, an HTTP status, or a reserved SDK code from codes.

message: String

Human-readable error message.

Implementations

impl ZaiError

pub fn from_api_response( status: u16, api_code: u16, api_message: String, ) -> Self

Convert an HTTP status code and API error response to a ZaiError.

pub fn is_rate_limit(&self) -> bool

Check if the error is a rate limit error

pub fn is_auth_error(&self) -> bool

Check if the error is an authentication error

pub fn category(&self) -> ErrorCategory

Classify this error into a single canonical ErrorCategory.

This is the one place the SDK decides whether an error is client-side, server-side, a rate limit, a network blip, etc. The convenience predicates (is_client_error, is_server_error) derive from it, so they can never disagree.

pub fn is_client_error(&self) -> bool

Check if the error is a client error (4xx), including auth and rate limiting (which arrive as 4xx responses).

pub fn is_server_error(&self) -> bool

Check if the error is a server error (5xx).

pub fn is_retryable(&self) -> bool

Whether retrying the request that produced this error could succeed.

This caller-facing helper marks transient rate limits (429, 1302, 1305), documented upstream execution failures, network failures, and HTTP 5xx errors as potentially retryable. Quota/billing exhaustion is deliberately not retryable. This method does not account for request idempotency or attempt limits; the internal HTTP transport applies those additional constraints.

pub fn is_sdk_error(&self) -> bool

Whether this error originates from the SDK itself rather than the API.

True iff code is in the reserved 9000–9999 band (see codes). Variants without a numeric code (NetworkError, JsonError, RealtimeError) return false.

pub fn compact(&self) -> String

Get a compact representation of error suitable for logging

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

Get error code if available

pub fn message(&self) -> String

Get error message

pub fn context(self, context: &str) -> Self

Attach an operational context to this error without losing its code or category.

Prepends "{context}: " to the human-readable message of every variant that carries one. Variants whose payload is a wrapped source error with no message slot (NetworkError, JsonError, RealtimeError) are returned unchanged — record their context in a tracing span instead.

Example

use zai_rs::client::error::ZaiError;

let err = ZaiError::ApiError {
    code: 1200,
    message: "bad model".to_string(),
};
let ctx = err.context("file parser create");
assert_eq!(ctx.code(), Some(1200));
assert_eq!(ctx.message(), "file parser create: bad model");

Trait Implementations

impl Clone for ZaiError

fn clone(&self) -> ZaiError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZaiError

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

Formats the value using the given formatter.

impl Display for ZaiError

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

Formats the value using the given formatter.

impl Error for ZaiError

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 ZaiError

Convert from reqwest::Error to ZaiError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ZaiError

Convert from serde_json::Error to ZaiError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ZaiError

Convert from std::io::Error to ZaiError.

Maps by std::io::ErrorKind so the category (file vs. timeout vs. generic I/O) survives propagation instead of collapsing to a single opaque Unknown{0}. A NetworkError cannot be built from an io::Error (it wraps reqwest::Error), so TimedOut is reported as an ApiError carrying codes::SDK_TIMEOUT.

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ZaiError

Available on crate feature realtime only.

Convert from a low-level WebSocket (tungstenite) error into a ZaiError. The original error is preserved as the #[source] of RealtimeErrorKind::WebSocket. Only available with the realtime feature.

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<RealtimeErrorKind> for ZaiError

Convert from a realtime transport error kind into a ZaiError.

fn from(kind: RealtimeErrorKind) -> Self

Converts to this type from the input type.

impl From<ValidationErrors> for ZaiError

Convert from validator::ValidationErrors to ZaiError

fn from(err: ValidationErrors) -> Self

Converts to this type from the input type.