Struct ErrorReport 

pub struct ErrorReport {
    pub kind: ErrorKind,
    pub retryable: bool,
    pub message: String,
    pub code: Option<String>,
    pub http_status: Option<u16>,
    pub refusal: bool,
    pub source_chain: Vec<String>,
    pub request_id: Option<String>,
    pub provider_response: Option<ProviderResponseError>,
}

A serde-able error crossing a wire boundary.

Field semantics:

• retryable is the one policy signal; it is decided at conversion time from the source’s own classification (see retryable_status).
• message is the source’s Display; source_chain is the Display of each source() link, outermost first, excluding message itself.
• code, http_status, refusal are copied when the source had them.

Fields

kind: ErrorKind

Normalized classification.

retryable: bool

Whether the same operation may reasonably be retried.

message: String

Human-readable description (the source’s Display).

code: Option<String>

A provider- or tool-specific machine code, when one was reported: for a provider’s reply, the transport’s own code when it gave one apart from the body, else the code the body names (provider_response::body_code).

http_status: Option<u16>

The HTTP status, when the failure had one.

refusal: bool

The failure was an intentional refusal rather than a fault.

source_chain: Vec<String>

Display of each source() link, outermost first.

request_id: Option<String>

The provider’s request id, when the failure had a response that carried one.

provider_response: Option<ProviderResponseError>

Preserved provider failure response, including available status, body, headers, and request ID.

Implementations

impl ErrorReport

pub fn new(kind: ErrorKind, message: impl Into<String>) -> Self

Build a report of kind with message and no other metadata.

pub fn with_retryable(self, retryable: bool) -> Self

Set retryable.

pub fn with_code(self, code: impl Into<String>) -> Self

Set the machine code.

pub fn with_http_status(self, status: u16) -> Self

Set the HTTP status.

pub fn refused(self) -> Self

Mark the report as an intentional refusal.

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Attach the provider’s request id.

pub const fn is_retryable(&self) -> bool

Whether the same operation may reasonably be retried.

impl ErrorReport

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

The provider response body preserved on this report, if any.

pub fn provider_response_json(&self) -> Result<Option<Value>, Error>

The preserved provider response body parsed as JSON, when present.

pub fn provider_response_headers(&self) -> Option<&HeaderMap>

The preserved provider response headers, if any.

pub fn provider_response_status(&self) -> Option<StatusCode>

The HTTP status this report carries, as a status code.

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

The provider’s transport request id, if the failure carried one.

Trait Implementations

impl Clone for ErrorReport

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ErrorReport

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

Formats the value using the given formatter.

impl Eq for ErrorReport

impl Error for ErrorReport

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<&MemoryError> for ErrorReport

fn from(error: &MemoryError) -> Self

Converts to this type from the input type.

impl From<&ProviderError> for ErrorReport

fn from(error: &ProviderError) -> Self

Converts to this type from the input type.

impl From<&ToolExecutionError> for ErrorReport

fn from(error: &ToolExecutionError) -> Self

Converts to this type from the input type.

impl From<&VectorStoreError> for ErrorReport

fn from(error: &VectorStoreError) -> Self

Converts to this type from the input type.

impl From<ErrorReport> for ToolExecutionError

Rebuilds a tool failure from a dispatch report.

An ErrorKind::Tool report keeps its tool kind; other kinds map to the closest ToolErrorKind. Retryability, code, HTTP status, and refusal are copied, the message is model-visible, and the report is the source().

fn from(report: ErrorReport) -> Self

Converts to this type from the input type.

impl From<MemoryError> for ErrorReport

fn from(error: MemoryError) -> Self

Converts to this type from the input type.

impl From<ProviderError> for ErrorReport

fn from(error: ProviderError) -> Self

Converts to this type from the input type.

impl From<ToolExecutionError> for ErrorReport

fn from(error: ToolExecutionError) -> Self

Converts to this type from the input type.

impl From<VectorStoreError> for ErrorReport

fn from(error: VectorStoreError) -> Self

Converts to this type from the input type.

impl PartialEq for ErrorReport

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ErrorReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ErrorReport