Struct Error 

pub struct Error { /* private fields */ }

A structured capability error with stable code, message, and JSON details.

Use Error::user for expected failures the model can act on and Error::internal for diagnostic details that are unsafe to show to the model. Internal messages are logged by the host and replaced with a generic model-visible error, so they must not contain credentials or other secrets.

Implementations

impl Error

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

Create an expected, model-visible domain error.

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

Create an internal error whose details must not reach the model.

pub fn details(self, details: impl Into<Value>) -> Self

Attach structured JSON details.

pub fn code(&self) -> &str

Stable machine-readable error code.

pub fn message(&self) -> &str

Human-readable error message.

pub fn details_value(&self) -> Option<&Value>

Structured details, when present.

pub fn visibility(&self) -> ErrorVisibility

Whether the error is model-visible or internal.

pub fn into_parts(self) -> (ErrorVisibility, String, String, Option<Value>)

Decompose the error for host serialization.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.