Struct InvokeError 

pub struct InvokeError { /* private fields */ }

Typed invoke error.

Replaces the previous Result<Value, String> contract. The kind selects a stable IPC error code and a fixed public message; detail carries host-only diagnostic text (e.g. for stderr logs) and is never forwarded to IPC clients, so guests cannot exfiltrate arbitrary content through the error path.

Implementations

impl InvokeError

pub const fn new(kind: InvokeErrorKind) -> Self

Create a new typed error with no host detail.

pub fn with_detail(kind: InvokeErrorKind, detail: impl Into<String>) -> Self

Create a new typed error carrying host-only diagnostic text.

detail is intended for eprintln! logs and must not be sent to IPC clients. Guests can fully control this string via the WIT handler-error payload, so it cannot be trusted for security decisions. It is truncated to MAX_DETAIL_BYTES on a UTF-8 char boundary so a malicious guest cannot grow host memory unboundedly through the error path.

pub const fn kind(&self) -> InvokeErrorKind

Error category.

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

Host-only diagnostic text. Never sent to IPC clients.

pub const fn stable_code(&self) -> &'static str

Stable IPC error code. Backwards-compatible with the v1/v2 wire format produced by the previous map_invoke_error string matching.

All four guest-reported WIT handler-error variants (invalid-model, invalid-input, unsupported-capability, execution-failed) collapse to handlerInternalError on the wire to preserve compatibility with v1/v2 clients. The host still distinguishes them internally via InvokeError::kind for logging and diagnostics.

pub const fn public_message(&self) -> &'static str

Fixed public message. Never contains guest-supplied content.

pub const fn retryable(&self) -> bool

Whether the caller may retry the same request on a fresh handler.

Trait Implementations

impl Clone for InvokeError

fn clone(&self) -> InvokeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InvokeError

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

Formats the value using the given formatter.

impl Display for InvokeError

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

Formats the value using the given formatter.

impl Error for InvokeError

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.