Enum ShellOutcome 

pub enum ShellOutcome {
    Exit(i32),
    Blocked,
    Background(BackgroundShellOutcome),
    BackgroundLookupError(BackgroundLookupError),
}

Outcome of a shell execution, carried alongside the rendered text so the MCP dispatch layer can surface failures in protocol metadata instead of only as an [exit:N] text footer (GitHub #389: clients had no programmatic way to detect ctx_shell failures and resorted to fragile regex matching).

Variants

Exit(i32)

The command ran; carries its real exit code (0 = success).

Blocked

The command never ran (allowlist/validation rejection, or a precondition failure such as an unreadable/oversized input file).

Background(BackgroundShellOutcome)

A managed background job status. Unlike a foreground Exit(1), a terminal failed job is never reclassified as grep-like result data.

BackgroundLookupError(BackgroundLookupError)

The requested background job is unknown or its retained verdict expired.

Implementations

impl ShellOutcome

pub fn is_error(&self) -> bool

Whether this outcome must be reported as a tool error (isError: true).

pub fn structured(&self) -> Option<Value>

Structured payload for CallToolResult.structuredContent, so guards can read state/exit/archive data instead of parsing output text. Ordinary foreground success (exit 0) stays token-neutral; background status always remains structured because clients may filter its text.

pub fn is_background_status(&self) -> bool

Whether this is a status body that the common pipeline must secure, archive and render before delivery.

pub fn is_terminal_background_status(&self) -> bool

Trait Implementations

impl Clone for ShellOutcome

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 ShellOutcome

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

Formats the value using the given formatter.

impl Eq for ShellOutcome

impl PartialEq for ShellOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ShellOutcome