Struct CommandResult 

pub struct CommandResult {
    pub stdout: CapturedOutput,
    pub stderr: CapturedOutput,
    pub stdin: CapturedInput,
    pub code: i32,
}

Result type for virtual command operations

Fields

stdout: CapturedOutput

stderr: CapturedOutput

stdin: CapturedInput

code: i32

Implementations

impl CommandResult

pub fn new( stdout: impl Into<CapturedOutput>, stderr: impl Into<CapturedOutput>, code: i32, ) -> Self

Create a result with readable output snapshots and a writable input record.

pub fn success(stdout: impl Into<String>) -> Self

Create a success result with stdout output

pub fn success_empty() -> Self

Create an empty success result

pub fn error(stderr: impl Into<String>) -> Self

Create an error result with stderr output

pub fn error_with_code(stderr: impl Into<String>, code: i32) -> Self

Create an error result with custom exit code

pub fn is_success(&self) -> bool

Check if the command was successful

pub fn exit_code(&self) -> i32

Exit code of the command.

This is an alias for the code field, mirroring the exitCode alias exposed by the JavaScript implementation (issue #36).

pub fn error_for_status(self) -> Result<CommandResult>

Turn a failing result into crate::Error::CommandFailed.

This is the Rust counterpart of the JavaScript errexit mode: a non-zero status becomes an error whose exit status is readable through both crate::Error::code and crate::Error::exit_code (issue #38). Successful results pass through unchanged.

use command_stream::utils::CommandResult;

let error = CommandResult::error_with_code("", 42)
    .error_for_status()
    .unwrap_err();
assert_eq!(error.code(), Some(42));
assert_eq!(error.exit_code(), error.code());

Trait Implementations

impl Clone for CommandResult

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 CommandResult

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

Formats the value using the given formatter.