Struct ExecResult 

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

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.

did_spill: bool

True if output was truncated and written to a spill file.

original_code: Option<i64>

The command’s original exit code before spill logic overwrote it with 2 or 3. Present only when did_spill is true and code was changed.

Implementations

impl ExecResult

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

Create a successful result with output.

pub fn with_output(output: OutputData) -> ExecResult

Create a successful result with structured output data.

The OutputData is the source of truth. Text is materialized lazily via text_out() when needed (pipes, redirects, command substitution).

For text-type output, JSON auto-detection still runs so that echo '{"key":1}' populates data for command substitution.

pub fn success_data(data: Value) -> ExecResult

Create a successful result with structured data.

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

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>) -> ExecResult

Create a failed result with an error message.

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

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 with_output_and_text( output: OutputData, text: impl Into<String>, ) -> ExecResult

Create a successful result with structured output and explicit pipe text.

Use this when a builtin needs custom text formatting that differs from the canonical OutputData::to_canonical_string() representation.

pub fn text_out(&self) -> Cow<'_, str>

Get text output, materializing from OutputData on demand.

Returns self.out if non-empty, otherwise falls back to OutputData::to_canonical_string(). This is the canonical way to get text for pipes, command substitution, and file redirects.

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

Formats the value using the given formatter.

impl Default for ExecResult

fn default() -> ExecResult

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExecResult

fn deserialize<__D>( __deserializer: __D, ) -> Result<ExecResult, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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) -> ToolResult

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 Serialize for ExecResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ExecResult