Enum CommandError 

pub enum CommandError {
    SpawnFailed {
        command: String,
        source: Error,
    },
    WaitFailed {
        command: String,
        source: Error,
    },
    KillFailed {
        command: String,
        timeout: Duration,
        source: Error,
    },
    ReadOutputFailed {
        command: String,
        stream: OutputStream,
        source: Error,
    },
    OpenInputFailed {
        command: String,
        path: PathBuf,
        source: Error,
    },
    OpenOutputFailed {
        command: String,
        stream: OutputStream,
        path: PathBuf,
        source: Error,
    },
    WriteInputFailed {
        command: String,
        source: Error,
    },
    WriteOutputFailed {
        command: String,
        stream: OutputStream,
        path: PathBuf,
        source: Error,
    },
    TimedOut {
        command: String,
        timeout: Duration,
        output: Box<CommandOutput>,
    },
    UnexpectedExit {
        command: String,
        exit_code: Option<i32>,
        expected: Vec<i32>,
        output: Box<CommandOutput>,
    },
}

Error returned while spawning, waiting for, or validating a command.

Author

Haixing Hu

Variants

SpawnFailed

The process could not be spawned.

Fields

command: String

Human-readable command representation.

source: Error

I/O error reported by the operating system.

WaitFailed

Waiting for process completion failed.

Fields

command: String

Human-readable command representation.

source: Error

I/O error reported while waiting for the child process.

KillFailed

The process could not be killed after exceeding the configured timeout.

Fields

command: String

Human-readable command representation.

timeout: Duration

Timeout that was exceeded.

source: Error

I/O error reported while killing the child process.

ReadOutputFailed

Reading one of the captured output streams failed.

Fields

command: String

Human-readable command representation.

stream: OutputStream

Stream whose reader failed.

source: Error

I/O error reported while reading the stream.

OpenInputFailed

Opening a stdin file failed.

Fields

command: String

Human-readable command representation.

path: PathBuf

Path that could not be opened.

source: Error

I/O error reported while opening the file.

OpenOutputFailed

Opening an output redirection file failed.

Fields

command: String

Human-readable command representation.

stream: OutputStream

Stream whose file could not be opened.

path: PathBuf

Path that could not be opened.

source: Error

I/O error reported while opening the file.

WriteInputFailed

Writing configured stdin bytes failed.

Fields

command: String

Human-readable command representation.

source: Error

I/O error reported while writing stdin.

WriteOutputFailed

Writing captured output to a redirection file failed.

Fields

command: String

Human-readable command representation.

stream: OutputStream

Stream whose redirected writer failed.

path: PathBuf

Path that could not be written.

source: Error

I/O error reported while writing the file.

TimedOut

The command exceeded the configured timeout and was terminated.

Fields

command: String

Human-readable command representation.

timeout: Duration

Timeout that was exceeded.

output: Box<CommandOutput>

Captured output available after terminating the child process.

UnexpectedExit

The command completed with an exit code not configured as successful.

Fields

command: String

Human-readable command representation.

exit_code: Option<i32>

Exit code reported by the process, if available.

expected: Vec<i32>

Configured successful exit codes.

output: Box<CommandOutput>

Captured output from the failed command.

Implementations

impl CommandError

pub const fn output(&self) -> Option<&CommandOutput>

Returns captured command output when this error carries it.

Returns

Some(output) for timeout and unexpected-exit errors, otherwise None.

pub fn command(&self) -> &str

Returns the command string associated with this error.

Returns

A human-readable command representation used in diagnostics.

Trait Implementations

impl Debug for CommandError

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

Formats the value using the given formatter.

impl Display for CommandError

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

Formats the value using the given formatter.

impl Error for CommandError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.