Enum CommandOutcome 

pub enum CommandOutcome {
    Success {
        output: String,
        total: Option<u64>,
    },
    RawOutput(String),
    UserError(String),
}

Result of a command execution: either success (exit 0) or a user-facing error (exit 1). Internal/unexpected errors are represented by anyhow::Error at the call site.

Invariant: Success.output must always be a valid JSON string — the pipeline handles format conversion. Commands must never store pre-formatted text here.

For commands like read whose text output is raw file content (not structured data), use RawOutput to bypass the JSON pipeline entirely.

Variants

Success

Successful operation — JSON output goes to stdout via the pipeline.

Fields

output: String

Always-valid JSON string (bare array, object, etc.). Never pre-formatted text.

total: Option<u64>

Optional total item count for pagination display.

RawOutput(String)

Raw text output, bypasses the JSON pipeline — printed directly to stdout as-is. Used by read command for text-format content output.

UserError(String)

User error (file not found, property missing, etc.) — output goes to stderr.

Implementations

impl CommandOutcome

pub fn success(output: String) -> Self

Construct a successful outcome carrying a JSON string with no total count.

pub fn success_with_total(output: String, total: u64) -> Self

Construct a successful outcome carrying a JSON string with a total item count.

Trait Implementations

impl Debug for CommandOutcome

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

Formats the value using the given formatter.