peace_item_sh_cmd 0.0.15

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

use std::marker::PhantomData;

use peace::{
    cfg::{accessors::Stored, State},
    data::Data,
};

use crate::{ShCmdExecutionRecord, ShCmdStateLogical};

/// 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<'exec, Id>
where
    Id: Send + Sync + 'static,
{
    /// Stored states of this item's previous execution.
    state_current_stored: Stored<'exec, State<ShCmdStateLogical<Id>, ShCmdExecutionRecord>>,

    /// Marker.
    marker: PhantomData<Id>,
}

impl<Id> ShCmdData<'_, Id>
where
    Id: Send + Sync + 'static,
{
    /// Returns the previous states.
    pub fn state_current_stored(
        &self,
    ) -> Option<&State<ShCmdStateLogical<Id>, ShCmdExecutionRecord>> {
        self.state_current_stored.get()
    }
}