peace_item_spec_sh_cmd 0.0.9

Manages running a shell command for the peace framework
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

use std::fmt;

use serde::{Deserialize, Serialize};

/// Diff between the current and desired file extraction.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ShCmdStateDiff {
    /// stdout output.
    stdout: String,
    /// stderr output.
    stderr: String,
}

impl ShCmdStateDiff {
    /// Returns a new `ShCmdStateDiff`.
    pub fn new(stdout: String, stderr: String) -> Self {
        Self { stdout, stderr }
    }

    /// Returns the `stdout` string, representing the logical state difference.
    pub fn stdout(&self) -> &str {
        self.stdout.as_ref()
    }

    /// Returns the `stderr` string, representing the display string.
    pub fn stderr(&self) -> &str {
        self.stderr.as_ref()
    }
}

impl std::ops::Deref for ShCmdStateDiff {
    type Target = String;

    fn deref(&self) -> &Self::Target {
        &self.stdout
    }
}

impl std::ops::DerefMut for ShCmdStateDiff {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.stdout
    }
}

impl fmt::Display for ShCmdStateDiff {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.stderr.fmt(f)
    }
}