Struct CommandResult 

#[non_exhaustive]
pub struct CommandResult {
    pub data: Value,
    pub metadata: CommandResultMetadata,
}

Data returned by a command handler.

Command handlers should return renderable data and keep output metadata on CommandSpec. The metadata field is reserved for future command-result extensions that are not known when the command is registered.

Construct with CommandResult::new, then chain with_* methods — never as a struct literal. #[non_exhaustive] enforces this so the engine can add fields without a breaking release.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

data: Value

JSON data rendered by the configured output formatter.

metadata: CommandResultMetadata

Optional command-result extension metadata.

Implementations

impl CommandResult

pub fn new(data: Value) -> Self

Creates a command result from renderable JSON data.

pub fn with_next_actions(self, actions: Vec<NextAction>) -> Self

Attaches suggested follow-up actions to this result.

pub fn with_dry_run(self) -> Self

Marks this result as a dry-run preview outcome.

Call only when the handler actually skipped its mutating step because CommandContext::dry_run was true. This requires the command to have opted in via CommandSpec::handles_dry_run — otherwise middleware never invokes the handler under --dry-run in the first place. Middleware tags the audit/activity outcome as dry-run instead of ok and marks the rendered envelope accordingly.

Trait Implementations

impl Clone for CommandResult

fn clone(&self) -> CommandResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandResult

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

Formats the value using the given formatter.

impl From<Value> for CommandResult

fn from(data: Value) -> Self

Converts to this type from the input type.

impl PartialEq for CommandResult

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CommandResult