Struct ToolResult 

pub struct ToolResult {
    pub name: String,
    pub output: String,
    pub exit_code: i32,
    pub metadata: Option<Value>,
    pub images: Vec<Attachment>,
    pub error_kind: Option<ToolErrorKind>,
    pub trust: ToolResultTrustV1,
}

Tool execution result returned by direct tool execution.

Fields

name: String

output: String

exit_code: i32

metadata: Option<Value>

images: Vec<Attachment>

Image attachments from tool execution (multi-modal output).

error_kind: Option<ToolErrorKind>

Structured discriminant for tool failures. Populated by built-in tools that can map their failure into a typed ToolErrorKind (e.g. edit/patch setting VersionConflict on a CAS rejection from WorkspaceError). Forwarded to the SDK so callers can react programmatically without parsing output.

trust: ToolResultTrustV1

Typed trust label applied at the value boundary. Absent wire payloads decode as ToolResultTrustV1::WorkspaceData, matching the previous implicit behavior for locally produced results.

Implementations

impl ToolResult

pub fn success(name: &str, output: String) -> Self

pub fn success_trusted(name: &str, output: String) -> Self

Host-trusted success: content produced by the runtime itself.

pub fn success_external(name: &str, output: String) -> Self

Success whose content crossed an external boundary (web, MCP, remote). Redaction review applies before prompt use.

pub fn error(name: &str, message: String) -> Self

pub fn error_with_kind(name: &str, message: String, kind: ToolErrorKind) -> Self

Trait Implementations

impl Clone for ToolResult

fn clone(&self) -> ToolResult

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, f: &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 From<ToolOutput> for ToolResult

fn from(output: ToolOutput) -> Self

Converts to this type from the input type.

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.