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

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

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

#[cfg(doc)]
use crate::ChildExt;
use crate::CommandDisplay;
#[cfg(doc)]
use crate::OutputContext;

/// A [`Child`] process combined with context about the [`Command`] that produced it.
///
/// The context information stored in this type is used to produce diagnostics in [`ChildExt`].
///
/// See: [`OutputContext`].
pub struct ChildContext<C> {
    child: C,
    command: Box<dyn CommandDisplay + Send + Sync>,
}

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

    /// Get the child process.
    pub fn into_child(self) -> C {
        self.child
    }

    /// Get a reference to the child process.
    pub fn child(&self) -> &C {
        &self.child
    }

    /// Get a mutable reference to the child process.
    pub fn child_mut(&mut self) -> &mut C {
        &mut self.child
    }

    /// Get a reference to the command which produced this child process.
    pub fn command(&self) -> &(dyn CommandDisplay + Send + Sync + 'static) {
        self.command.borrow()
    }

    /// Get a reference to the [`Box`] containing the command which produced this child process.
    ///
    /// This value, unlike the return value from [`ChildContext::command`], can be [`Clone`]d.
    #[expect(clippy::borrowed_box)]
    pub fn command_boxed(&self) -> &Box<dyn CommandDisplay + Send + Sync> {
        &self.command
    }

    /// Get the child and command which produced the child.
    pub fn into_child_and_command(self) -> (C, Box<dyn CommandDisplay + Send + Sync>) {
        (self.child, self.command)
    }
}

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