Skip to main content

CommandError

Enum CommandError 

Source
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,
    },
    TimedOut {
        command: String,
        timeout: Duration,
        output: Box<CommandOutput>,
    },
    UnexpectedExit {
        command: String,
        exit_code: Option<i32>,
        expected: Vec<i32>,
        output: Box<CommandOutput>,
    },
}
Expand description

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.

§

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§

Source§

impl CommandError

Source

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.

Source

pub fn command(&self) -> &str

Returns the command string associated with this error.

§Returns

A human-readable command representation used in diagnostics.

Trait Implementations§

Source§

impl Debug for CommandError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for CommandError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for CommandError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.