command-error 0.8.0

Detailed error messages and status checking for `std::process::Command`
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use std::borrow::Borrow;
use std::fmt::Debug;
use std::fmt::Display;
use std::process::ExitStatus;

#[cfg(doc)]
use std::process::Command;
#[cfg(doc)]
use std::process::Output;

#[cfg(doc)]
use crate::CommandExt;

use crate::CommandDisplay;
use crate::Error;
use crate::OutputError;
use crate::OutputLike;

/// [`Output`] combined with context about the [`Command`] that produced it.
///
/// This contains additional information about the command that was run (via a [`CommandDisplay`]
/// object) and can be used to construct error messages (for use in methods like
/// [`CommandExt::output_checked_as`]).
///
/// Note that because [`ExitStatus`] has a trivial implementation for [`OutputLike`] (where
/// [`stdout`][OutputLike::stdout] and [`stderr`][OutputLike::stderr] return empty strings), this
/// is also used as context for [`status`][`CommandExt::status_checked`] calls.
pub struct OutputContext<O> {
    output: O,
    command: Box<dyn CommandDisplay + Send + Sync>,
}

impl<O> OutputContext<O>
where
    O: OutputLike + Send + Sync + 'static,
{
    /// Construct a new [`OutputContext`].
    pub fn new(output: O, command: Box<dyn CommandDisplay + Send + Sync>) -> Self {
        Self { output, command }
    }

    /// Get the [`OutputLike`] data contained in this context object.
    pub fn into_output(self) -> O {
        self.output
    }

    /// Get a reference to the [`OutputLike`] data contained in this context object.
    pub fn output(&self) -> &O {
        &self.output
    }

    /// Get the command's [`ExitStatus`].
    pub fn status(&self) -> ExitStatus {
        self.output.status()
    }

    /// Get a reference to the command contained in this context object, for use in error messages
    /// or diagnostics.
    pub fn command(&self) -> &(dyn CommandDisplay + Send + Sync) {
        self.command.borrow()
    }

    /// Get the command contained in this context object, for use in error messages
    /// or diagnostics.
    pub fn into_command(self) -> Box<dyn CommandDisplay> {
        self.command
    }

    /// Get the output and command contained in this context object.
    ///
    /// Unlike [`OutputContext::into_output`] and [`OutputContext::into_command`], this lets you
    /// extract both fields.
    pub fn into_output_and_command(self) -> (O, Box<dyn CommandDisplay>) {
        (self.output, self.command)
    }

    /// Construct an error that indicates this command failed, containing information about the
    /// command and its output.
    ///
    /// See [`CommandExt`] for examples of the error format.
    ///
    /// This is a thin wrapper around [`OutputContext::output_error`].
    pub fn error(self) -> Error {
        Error::from(self.output_error())
    }

    /// Construct an error that indicates this command failed, containing information about the
    /// command and its output.
    ///
    /// This is like [`OutputContext::error`], but it returns the inner [`OutputError`] directly,
    /// rather than wrapping it in an [`Error`].
    pub fn output_error(self) -> OutputError {
        OutputError::new(self.command, Box::new(self.output))
    }

    /// Construct an error that indicates this command failed, containing information about the
    /// command, its output, and the provided error message.
    ///
    /// See [`CommandExt::output_checked_as`] for examples of the error format.
    pub fn error_msg<E>(self, message: E) -> Error
    where
        E: Debug + Display + Send + Sync + 'static,
    {
        Error::from(
            OutputError::new(self.command, Box::new(self.output)).with_message(Box::new(message)),
        )
    }

    pub(crate) fn maybe_error_msg<E>(self, message: Option<E>) -> Error
    where
        E: Debug + Display + Send + Sync + 'static,
    {
        let ret = self.output_error();
        Error::from(match message {
            Some(message) => ret.with_message(Box::new(message)),
            None => ret,
        })
    }
}