Struct ErrorDetail 

pub struct ErrorDetail {
    pub kind: ErrorKind,
    pub code: ErrorCode,
    pub message: String,
    pub user_message: String,
    pub retry_after_ms: Option<u64>,
    pub source: ErrorSource,
}

Structured failure detail attached to a crate::value::Value::FatalError and to every EngineEvent::Error. Replaces the previous (message, kind) shape with a richer envelope so SDKs can decide what to do, users get actionable text, and developers get structured fields for OTel/logs.

Construction patterns:

• Simple: ErrorDetail::from_kind(ErrorKind::ScriptError, "div by zero") — pulls a generic code (AKRIBES-E-SCRIPT-ERROR) and the kind’s default user message.
• Specific: ErrorDetail::new(ErrorCode::ProviderRateLimit, "...") — code drives kind + default user_message via ErrorCode::kind.
• With retry hint: .with_retry_after_ms(30_000).
• With source: .with_source(ErrorSource::default().with_task("foo")).

Fields

kind: ErrorKind

code: ErrorCode

message: String

Developer-facing message — full detail, may include sanitized stack/protocol fragments. Always non-empty.

user_message: String

User-facing single-paragraph summary + suggested action. Always non-empty (defaults to ErrorCode::default_user_message).

retry_after_ms: Option<u64>

When the provider supplied a Retry-After (or equivalent), the suggested wait in milliseconds. None when not known.

source: ErrorSource

Where the error originated. Empty (is_empty()) when no attribution is available.

Implementations

impl ErrorDetail

pub fn new(code: ErrorCode, message: impl Into<String>) -> Self

Construct from a code + developer message. Kind and user_message are derived from the code.

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

Construct from an existing kind when no specific code is yet available. Picks the closest “Other” code for that kind, and for rate-limit/server messages also extracts a retry_after_ms hint when the upstream response embedded one.

pub fn with_user_message(self, msg: impl Into<String>) -> Self

Override the user-facing message. Use when the default for the code isn’t specific enough (e.g. embedding the offending value).

pub fn with_retry_after_ms(self, ms: u64) -> Self

pub fn with_source(self, source: ErrorSource) -> Self

pub fn with_task(self, task: impl Into<String>) -> Self

Convenience: builder-style task attribution.

pub fn is_retryable(&self) -> bool

Whether retrying as-is may succeed. Pulls from the kind plus retry_after_ms (an explicit hint always implies retryable).

pub fn suggested_action(&self) -> SuggestedAction

Trait Implementations

impl Clone for ErrorDetail

fn clone(&self) -> ErrorDetail

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorDetail

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorDetail

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ErrorDetail

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

Renders as <wire-code>: <message> so log lines and the legacy “string error” shape stay readable. Use the structured fields directly when constructing JSON wire payloads.

impl PartialEq for ErrorDetail

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ErrorDetail

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 ErrorDetail