Struct ErrorEnvelope 

pub struct ErrorEnvelope {
    pub is_error: bool,
    pub error_class: ErrorClass,
    pub message: String,
    pub ora_code: Option<i32>,
    pub suggested_tool: Option<String>,
    pub fuzzy_matches: Vec<String>,
    pub next_steps: Vec<String>,
    pub retry_after_ms: Option<u64>,
}

The actionable, agent-facing error payload (plan §8.2).

is_error is serialized as isError to match the MCP tool-result shape. Empty optional fields are omitted from the wire form so envelopes stay terse.

Fields

is_error: bool

Always true; marks the MCP tool result as an error.

error_class: ErrorClass

The machine-stable class.

message: String

Human/LLM-readable explanation. Never contains bind values or secrets.

ora_code: Option<i32>

The originating Oracle ORA- code, when the error came from the DB.

suggested_tool: Option<String>

The single best tool to call next.

fuzzy_matches: Vec<String>

Near-miss candidates (e.g. similarly-named objects) for ObjectNotFound.

next_steps: Vec<String>

Ordered, concrete remediation steps an agent can follow.

retry_after_ms: Option<u64>

For Busy/Transient: how long to wait before retrying.

Implementations

impl ErrorEnvelope

pub fn new(error_class: ErrorClass, message: impl Into<String>) -> Self

Construct a new envelope of the given class with a message, deriving the default suggested tool for the class.

pub fn with_ora_code(self, code: i32) -> Self

Attach the originating Oracle error code.

pub fn with_suggested_tool(self, tool: impl Into<String>) -> Self

Override the suggested tool.

pub fn with_fuzzy_matches(self, matches: Vec<String>) -> Self

Attach fuzzy near-miss candidates.

pub fn with_next_step(self, step: impl Into<String>) -> Self

Append a remediation step.

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

Attach a retry-after hint (milliseconds).

pub fn to_json(&self) -> Value

Render as a serde_json::Value for embedding in an MCP tool result.

Panics

Never in practice — the envelope is composed of plain owned data that always serializes; a failure would indicate a serde bug, which we surface as a deterministic fallback object rather than unwrapping.

Trait Implementations

impl Clone for ErrorEnvelope

fn clone(&self) -> ErrorEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ErrorEnvelope

impl PartialEq for ErrorEnvelope

fn eq(&self, other: &ErrorEnvelope) -> 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 ErrorEnvelope

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 ErrorEnvelope