system 0.3.4

Cross-platform crate to easily run shell commands, similar to the C system function.
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
120
121

//! Cross-platform crate to easily run shell commands, similar to the C `system` function.

use std::{
    io,
    process::{Command, ExitStatus, Output},
};

#[cfg(target_os = "windows")]
use std::os::windows::process::CommandExt;

/// Trait to allow for the creation of objects representing a shell commands.
pub trait System<T> {
    /// Constructs a new `T` that runs the given shell command when executed.
    fn system(command: &str) -> T;
}

impl System<Command> for Command {
    #[cfg(target_os = "windows")]
    /// Constructs a new [Command] that runs the given shell command when executed.
    ///
    /// See [Command::new] for the default configuration.
    ///
    /// # Example
    ///
    /// ```rust
    /// use std::process::Command;
    ///
    /// use system::System;
    ///
    /// fn main() {
    ///     let out = Command::system("echo Hello, world!")
    ///         .output()
    ///         .expect("Failed to run command.");
    ///     let stdout = String::from_utf8_lossy(&out.stdout);
    ///
    ///     #[cfg(target_os = "windows")]
    ///     assert_eq!(stdout, "Hello, world!\r\n");
    ///
    ///     #[cfg(not(target_os = "windows"))]
    ///     assert_eq!(stdout, "Hello, world!\n");
    /// }
    /// ```
    fn system(command: &str) -> Command {
        let mut rust_command = Command::new("cmd");
        rust_command.arg("/c");
        rust_command.raw_arg(&command);
        return rust_command;
    }

    #[cfg(not(target_os = "windows"))]
    /// Construct a new [Command] that runs the given system command when executed.
    ///
    /// See [Command::new] for the default configuration.
    ///
    /// # Example
    ///
    /// ```rust
    /// use std::process::Command;
    ///
    /// use system::System;
    ///
    /// fn main() {
    ///     let out = Command::system("echo Hello, world!")
    ///         .output()
    ///         .expect("Failed to run command.");
    ///     let stdout = String::from_utf8_lossy(&out.stdout);
    ///
    ///     #[cfg(target_os = "windows")]
    ///     assert_eq!(stdout, "Hello, world!\r\n");
    ///
    ///     #[cfg(not(target_os = "windows"))]
    ///     assert_eq!(stdout, "Hello, world!\n");
    /// }
    /// ```
    fn system(command: &str) -> Command {
        let mut rust_command = Command::new("sh");
        rust_command.arg("-c");
        rust_command.arg(&command);
        return rust_command;
    }
}

/// Run a shell command and return the [ExitStatus].
///
/// Stdin, stdout, and stderr are inherited from the parent.
///
/// # Example
/// ```rust
/// use system::system;
///
/// fn main() {
///     // Prints "Hello, world!"
///     system("echo Hello, world!").expect("Failed to run command.");
/// }
/// ```
pub fn system(command: &str) -> io::Result<ExitStatus> {
    Command::system(command).status()
}

/// Run a shell command, capture its output, and return the [Output].
///
/// Stdout and stderr are captured and stdin is not inherited.
///
/// # Example
/// ```rust
/// use system::system_output;
///
/// fn main() {
///     let out = system_output("echo Hello, world!").expect("Failed to run command.");
///     let stdout = String::from_utf8_lossy(&out.stdout);
///
///     #[cfg(target_os = "windows")]
///     assert_eq!(stdout, "Hello, world!\r\n");
///
///     #[cfg(not(target_os = "windows"))]
///     assert_eq!(stdout, "Hello, world!\n");
/// }
/// ```
pub fn system_output(command: &str) -> io::Result<Output> {
    Command::system(command).output()
}