Struct ToolResult 

#[non_exhaustive]
pub struct ToolResult {
    pub code: i32,
    pub stdout: String,
    pub stderr: String,
    pub data: Option<Value>,
    pub output: Option<OutputData>,
    pub did_spill: bool,
    pub original_code: Option<i64>,
    pub content_type: Option<String>,
    pub baggage: BTreeMap<String, String>,
}

Result from tool execution via backend.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: i32

Exit code (0 = success).

stdout: String

Standard output.

stderr: String

Standard error.

data: Option<Value>

Structured data (if any).

output: Option<OutputData>

Structured output data for rendering (preserved from ExecResult).

did_spill: bool

True if the output limiter capped this result (propagated from ExecResult). See ExecResult.did_spill for the full semantics (disk spill vs. in-memory truncation, exit code remap to 3).

original_code: Option<i64>

The command’s original exit code before spill logic overwrote it (propagated from ExecResult). Present only when did_spill is true and code was changed. See ExecResult.original_code.

content_type: Option<String>

MIME content type hint (propagated from ExecResult).

baggage: BTreeMap<String, String>

Opaque key-value context (propagated from ExecResult).

Implementations

impl ToolResult

pub fn success(stdout: impl Into<String>) -> ToolResult

Create a successful result.

pub fn failure(code: i32, stderr: impl Into<String>) -> ToolResult

Create a failed result.

pub fn with_data(stdout: impl Into<String>, data: Value) -> ToolResult

Create a result with structured data.

pub fn ok(&self) -> bool

Check if the tool execution succeeded.

pub fn with_output(self, output: Option<OutputData>) -> ToolResult

Set the structured output-data payload, returning self for chaining.

pub fn with_content_type(self, ct: impl Into<String>) -> ToolResult

Set the content-type hint, returning self for chaining.

pub fn with_baggage(self, baggage: BTreeMap<String, String>) -> ToolResult

Replace the baggage map, returning self for chaining.

pub fn with_did_spill(self, did_spill: bool) -> ToolResult

Set the spill flag, returning self for chaining.

pub fn with_original_code(self, original_code: Option<i64>) -> ToolResult

Set the pre-spill original exit code, returning self for chaining.

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<(), Error>

Formats the value using the given formatter.

impl From<ExecResult> for ToolResult

fn from(exec: ExecResult) -> ToolResult

Converts to this type from the input type.

impl From<ToolResult> for ExecResult

fn from(result: ToolResult) -> ExecResult

The symmetric peer of From<ExecResult> for ToolResult above — every field that direction preserves, this direction must preserve too, or a backend-registered tool’s structured data/content_type/baggage silently vanishes crossing back into the kernel (the embedder seam: x=$(embedder_tool) and for r in $(embedder_tool) need .data to see typed results, not just stdout text).

data uses json_to_value_no_envelope rather than the internal round-trip conversion: a backend tool’s JSON is external input, so an object shaped like the byte envelope must stay a plain record, never silently auto-decode to Value::Bytes.