Struct ToolResult 

pub struct ToolResult { /* private fields */ }

The single structured execution view used by dispatch, hooks, and telemetry.

Each result has exactly one disposition. The tagged state is private so tool authors keep returning ordinary Result values while runtime callers use the stable query methods on this type.

Implementations

impl ToolResult

pub fn success(output: ToolOutput) -> Self

Creates a successful canonical tool result.

pub fn failed(error: ToolExecutionError) -> Self

Creates a failed or refused canonical tool result.

pub fn skipped(reason: impl Into<String>) -> Self

Creates a result for a call skipped by runtime policy.

pub fn with_output(self, output: ToolOutput) -> Self

The same result with its model-visible output replaced, keeping its disposition: a success or a skip carries the new output; a failure or refusal keeps its error and presents the new output to the model.

pub fn output(&self) -> &ToolOutput

Current model-visible output, including replacements made by Self::with_output.

pub fn error(&self) -> Option<&ToolExecutionError>

Structured execution error, if execution failed.

Intentional refusals are available through Self::refusal instead.

pub fn refusal(&self) -> Option<&ToolExecutionError>

Structured refusal details, if the tool intentionally declined the call.

This is mutually exclusive with Self::error.

pub fn is_success(&self) -> bool

Whether the tool completed successfully.

pub fn is_error(&self) -> bool

Whether execution failed.

An intentional refusal is not an execution error; inspect Self::is_refused instead.

pub fn is_skipped(&self) -> bool

Whether the framework skipped execution before the tool body ran.

pub fn is_refused(&self) -> bool

Whether a tool refused execution.

pub fn is_error_kind(&self, kind: ToolErrorKind) -> bool

Whether this is an error of exactly kind.

A refusal does not match, even though its envelope uses the normalized ToolErrorKind::PermissionDenied kind.

pub fn into_result(self) -> Result<ToolOutput, ToolExecutionError>

Converts success or skipped dispositions to Ok(output) and errors or refusals to Err(error).

pub fn status_name(&self) -> &'static str

Stable telemetry disposition: success, error, denied, or skipped.

Trait Implementations

impl Clone for ToolResult

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 ToolResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.