Struct StructuredError 

pub struct StructuredError {
    pub category: ErrorCategory,
    pub message: String,
    pub is_retryable: bool,
    pub status_code: Option<u16>,
    pub provider: Option<String>,
    pub original_error: Option<String>,
    pub token_count: Option<u64>,
    pub token_limit: Option<u64>,
    pub retry_after: Option<f64>,
}

Base structured error with metadata.

Fields

category: ErrorCategory

message: String

is_retryable: bool

status_code: Option<u16>

provider: Option<String>

original_error: Option<String>

token_count: Option<u64>

For context overflow: how many tokens were in the prompt.

token_limit: Option<u64>

For context overflow: what the model limit is.

retry_after: Option<f64>

For rate limit: seconds to wait before retrying.

Implementations

impl StructuredError

pub fn should_compact(&self) -> bool

Whether this error should trigger context compaction.

pub fn should_retry(&self) -> bool

Whether the operation should be retried.

pub fn error_code(&self) -> &str

Return a stable error code for this error.

Error codes follow the pattern EXXXX_DESCRIPTION:

• E1xxx: Rate limiting and quota errors
• E2xxx: Tool and timeout errors
• E3xxx: Context and token errors
• E4xxx: Authentication and permission errors
• E5xxx: Gateway and network errors
• E9xxx: Unknown/unclassified errors

pub fn to_json(&self) -> Value

Serialize this error to a structured JSON value for reporting.

pub fn recovery_strategy(&self) -> RecoveryStrategy

Return the recommended recovery strategy for this error.

pub fn api(message: impl Into<String>, status_code: Option<u16>) -> Self

Create a generic API error.

pub fn context_overflow( message: impl Into<String>, provider: Option<String>, token_count: Option<u64>, token_limit: Option<u64>, ) -> Self

Create a context overflow error.

pub fn output_length(message: impl Into<String>) -> Self

Create an output length error.

pub fn rate_limit( message: impl Into<String>, provider: Option<String>, retry_after: Option<f64>, ) -> Self

Create a rate limit error.

pub fn auth( message: impl Into<String>, status_code: Option<u16>, provider: Option<String>, ) -> Self

Create an authentication error.

pub fn gateway( message: impl Into<String>, status_code: Option<u16>, provider: Option<String>, original_error: Option<String>, ) -> Self

Create a gateway error.

Trait Implementations

impl Clone for StructuredError

fn clone(&self) -> StructuredError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructuredError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StructuredError

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

Formats the value using the given formatter.

impl Error for StructuredError

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 Serialize for StructuredError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.