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

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

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

use crate::CommandDisplay;
use crate::OutputContext;

/// An optional [`ExitStatus`] combined with context about the [`Command`] that produced it.
///
/// See also: [`OutputContext`].
pub struct TryWaitContext {
    status: Option<ExitStatus>,
    command: Box<dyn CommandDisplay + Send + Sync>,
}

impl TryWaitContext {
    /// Construct a new [`TryWaitContext`].
    pub fn new(status: Option<ExitStatus>, command: Box<dyn CommandDisplay + Send + Sync>) -> Self {
        Self { status, command }
    }

    /// Get the result of the [`Child::try_wait`] call.
    pub fn status(&self) -> Option<ExitStatus> {
        self.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 + Send + Sync)> {
        self.command
    }

    /// If the [`ExitStatus`] is present, get an [`OutputContext`] for constructing error messages.
    pub fn into_output_context(self) -> Option<OutputContext<ExitStatus>> {
        self.status
            .map(|status| OutputContext::new(status, self.command))
    }
}

impl Debug for TryWaitContext {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("TryWaitContext")
            .field("status", &self.status)
            .field("command", &self.command.to_string())
            .finish()
    }
}