Struct Output 

pub struct Output {
    pub status: String,
    pub output: String,
    pub data: Option<Value>,
    pub backup_path: Option<PathBuf>,
    pub error: Option<String>,
    pub duration_ms: u64,
    pub telemetry_delta: Telemetry,
    pub artifacts: Vec<PathBuf>,
}

Output from capability execution.

Returned by every Capability::execute call. Provides a standardized envelope across all capabilities — status distinguishes ok/error, output carries human-readable text, data holds structured JSON, and error contains the failure message when status is "error".

Invariants

• status is always "ok" or "error".
• When status == "error", error is Some.
• When status == "ok", error is None.
• data is capability-specific structured output (may be None).
• backup_path is set when a file was backed up before mutation.
• artifacts lists paths of files created or modified by the capability.

Constructors

Use Output::ok for successful executions and Output::error for failures. Do not construct Output directly — the constructors enforce the invariants above.

Fields

status: String

Execution status: "ok" or "error".

output: String

Human-readable result message.

data: Option<Value>

Capability-specific structured data (JSON). None when the capability produces no structured output.

backup_path: Option<PathBuf>

Path to a backup file created before mutation. None when no backup was created (e.g., read-only operations, new files).

error: Option<String>

Error message when status == "error". None when status == "ok".

duration_ms: u64

Wall-clock execution duration in milliseconds.

telemetry_delta: Telemetry

Telemetry delta captured around the execution (before/after).

artifacts: Vec<PathBuf>

Paths of files created or modified by this capability execution.

Implementations

impl Output

pub fn ok(output: String) -> Self

Creates a successful output with the given human-readable message.

Sets status to "ok", error to None, and all other fields to sensible defaults. Callers should populate data, backup_path, and artifacts after construction as needed.

Examples

use runtimo_core::capability::Output;

let out = Output::ok("Read 42 bytes".into());
assert_eq!(out.status, "ok");
assert!(out.error.is_none());

pub fn error(output: String, error: String) -> Self

Creates an error output with the given human-readable message and error detail.

Sets status to "error" and error to Some(error). The output field carries a caller-facing summary; error carries the machine-parseable failure reason.

Examples

use runtimo_core::capability::Output;

let out = Output::error("failed".into(), "file not found".into());
assert_eq!(out.status, "error");
assert_eq!(out.error.as_deref(), Some("file not found"));

pub fn to_json(&self) -> Value

Serializes the output to a JSON Value.

All fields are included — this is the canonical JSON representation written to the WAL and returned to clients.

Trait Implementations

impl Clone for Output

fn clone(&self) -> Output

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Output

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Output

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Output

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

where __S: Serializer,

Serialize this value into the given Serde serializer.