Struct ExecResult 

pub struct ExecResult {
    pub code: i64,
    pub out: String,
    pub err: String,
    pub data: Option<Value>,
    pub output: Option<OutputData>,
}

The result of executing a command or pipeline.

Fields accessible via ${?.field}:

• code — exit code (0 = success)
• ok — true if code == 0
• err — error message if failed
• out — raw stdout as string
• data — parsed JSON from stdout (if valid JSON)

Fields

code: i64

Exit code. 0 means success.

out: String

Raw standard output as a string (canonical for pipes).

err: String

Raw standard error as a string.

data: Option<Value>

Parsed JSON data from stdout, if stdout was valid JSON.

output: Option<OutputData>

Structured output data for rendering.

Implementations

impl ExecResult

pub fn success(out: impl Into<String>) -> Self

Create a successful result with output.

pub fn with_output(output: OutputData) -> Self

Create a successful result with structured output data.

This is the preferred constructor for new code. The OutputData provides a unified model for all output types.

pub fn success_data(data: Value) -> Self

Create a successful result with structured data.

pub fn success_with_data(out: impl Into<String>, data: Value) -> Self

Create a successful result with both text output and structured data.

Use this when a command should have:

• Text output for pipes and traditional shell usage
• Structured data for iteration and programmatic access

The data field takes precedence for command substitution in contexts like for i in $(cmd) where the structured data can be iterated.

pub fn failure(code: i64, err: impl Into<String>) -> Self

Create a failed result with an error message.

pub fn from_output( code: i64, stdout: impl Into<String>, stderr: impl Into<String>, ) -> Self

Create a result from raw output streams.

JSON auto-detection: On success (code 0), stdout is checked for valid JSON. If it parses, the result is stored in .data as structured data. This enables for i in $(external-command) to iterate over JSON arrays returned by MCP tools and external commands. This is intentional — external tools communicate structured data via JSON stdout, and kaish makes it available for iteration without requiring manual jq parsing.

pub fn ok(&self) -> bool

True if the command succeeded (exit code 0).

pub fn get_field(&self, name: &str) -> Option<Value>

Get a field by name, for variable access like ${?.field}.

Trait Implementations

impl Clone for ExecResult

fn clone(&self) -> ExecResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecResult

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

Formats the value using the given formatter.

impl Default for ExecResult

fn default() -> Self

Returns the “default value” for a type.

impl From<ExecResult> for ControlFlow

fn from(result: ExecResult) -> Self

Converts to this type from the input type.

impl From<ExecResult> for ToolResult

fn from(exec: ExecResult) -> Self

Converts to this type from the input type.

impl PartialEq for ExecResult

fn eq(&self, other: &ExecResult) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ExecResult