Struct OutputError

pub struct OutputError { /* private fields */ }

An error from a failed command, typically due to a non-zero exit status.

Produced by CommandExt. This indicates a command that failed, typically with a non-zero exit code, rather than a command that failed to start (as in ExecError).

let mut command = Command::new("sh");
command.args(["-c", "echo puppy doggy"]);
let displayed: Utf8ProgramAndArgs = (&command).into();
let error = OutputError::new(
    Box::new(displayed),
    Box::new(Output {
        status: ExitStatus::default(),
        stdout: "puppy doggy\n".as_bytes().to_vec(),
        stderr: Vec::new(),
    })
);
assert_eq!(
    error.to_string(),
    indoc!(
        "`sh` failed: exit status: 0
        Command failed: `sh -c 'echo puppy doggy'`
        Stdout:
          puppy doggy"
    ),
);
assert_eq!(
    error.with_message(Box::new("no kitties found!")).to_string(),
    indoc!(
        "`sh` failed: no kitties found!
        exit status: 0
        Command failed: `sh -c 'echo puppy doggy'`
        Stdout:
          puppy doggy"
    )
);

Implementations

impl OutputError

pub fn new( command: Box<dyn CommandDisplay + Send + Sync>, output: Box<dyn OutputLike + Send + Sync>, ) -> Self

Construct a new OutputError.

pub fn with_message(self, message: Box<dyn DebugDisplay + Send + Sync>) -> Self

Attach a user-defined message to this error.

pub fn without_message(self) -> Self

Remove a user-defined message from this error, if any.

Trait Implementations

impl Debug for OutputError

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

Formats the value using the given formatter.

impl Display for OutputError

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

Formats the value using the given formatter.

impl Error for OutputError

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.

impl From<OutputError> for Error

fn from(error: OutputError) -> Self

Converts to this type from the input type.