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

use peace::{
    data::{
        accessors::{RMaybe, R},
        Data,
    },
    resources::states::StatesSaved,
};

use crate::ShCmdParams;

/// Data used to run a shell command.
///
/// # Type Parameters
///
/// * `Id`: A zero-sized type used to distinguish different command execution
///   parameters from each other.
#[derive(Data, Debug)]
pub struct ShCmdData<'op, Id>
where
    Id: Send + Sync + 'static,
{
    /// Parameters to determine what shell command to run.
    sh_cmd_params: R<'op, ShCmdParams<Id>>,

    /// Saved states with this item spec's previous execution.
    states_saved: RMaybe<'op, StatesSaved>,
}

impl<'op, Id> ShCmdData<'op, Id>
where
    Id: Send + Sync + 'static,
{
    /// Returns the parameters to determine what shell command to run.
    pub fn sh_cmd_params(&self) -> &ShCmdParams<Id> {
        &self.sh_cmd_params
    }

    /// Returns the previous states.
    pub fn states_saved(&self) -> Option<&StatesSaved> {
        self.states_saved.as_deref()
    }
}