Struct CmdCtxMpsfFields 

pub struct CmdCtxMpsfFields<'ctx, CmdCtxTypesT>
where
    CmdCtxTypesT: CmdCtxTypes,
{

    pub interruptibility_state: InterruptibilityState<'static, 'static>,
    pub workspace: OwnedOrRef<'ctx, Workspace>,
    pub profiles: Vec<Profile>,
    pub profile_dirs: BTreeMap<Profile, ProfileDir>,
    pub profile_history_dirs: BTreeMap<Profile, ProfileHistoryDir>,
    pub flow: OwnedOrRef<'ctx, Flow<CmdCtxTypesT::AppError>>,
    pub flow_dirs: BTreeMap<Profile, FlowDir>,
    pub workspace_params_type_reg: TypeReg<CmdCtxTypesT::WorkspaceParamsKey, BoxDt>,
    pub workspace_params: WorkspaceParams<CmdCtxTypesT::WorkspaceParamsKey>,
    pub profile_params_type_reg: TypeReg<CmdCtxTypesT::ProfileParamsKey, BoxDt>,
    pub profile_to_profile_params: BTreeMap<Profile, ProfileParams<CmdCtxTypesT::ProfileParamsKey>>,
    pub flow_params_type_reg: TypeReg<CmdCtxTypesT::FlowParamsKey, BoxDt>,
    pub profile_to_flow_params: BTreeMap<Profile, FlowParams<CmdCtxTypesT::FlowParamsKey>>,
    pub profile_to_states_current_stored: BTreeMap<Profile, Option<StatesCurrentStored>>,
    pub params_specs_type_reg: ParamsSpecsTypeReg,
    pub profile_to_params_specs: BTreeMap<Profile, ParamsSpecs>,
    pub states_type_reg: StatesTypeReg,
    pub resources: Resources<SetUp>,
}

Fields of CmdCtxMpsf.

Design

This is necessary so that the output can be separated from the fields during execution.

Fields

interruptibility_state: InterruptibilityState<'static, 'static>

Whether the CmdExecution is interruptible.

If it is, this holds the interrupt channel receiver.

workspace: OwnedOrRef<'ctx, Workspace>

Workspace that the peace tool runs in.

profiles: Vec<Profile>

The profiles that are accessible by this command.

profile_dirs: BTreeMap<Profile, ProfileDir>

Profile directories that store params and flows.

profile_history_dirs: BTreeMap<Profile, ProfileHistoryDir>

Directories of each profile’s execution history.

flow: OwnedOrRef<'ctx, Flow<CmdCtxTypesT::AppError>>

The chosen process flow.

flow_dirs: BTreeMap<Profile, FlowDir>

Flow directory that stores params and states.

workspace_params_type_reg: TypeReg<CmdCtxTypesT::WorkspaceParamsKey, BoxDt>

Type registry for WorkspaceParams deserialization.

workspace_params: WorkspaceParams<CmdCtxTypesT::WorkspaceParamsKey>

Workspace params.

profile_params_type_reg: TypeReg<CmdCtxTypesT::ProfileParamsKey, BoxDt>

Type registry for ProfileParams deserialization.

profile_to_profile_params: BTreeMap<Profile, ProfileParams<CmdCtxTypesT::ProfileParamsKey>>

Profile params for the profile.

flow_params_type_reg: TypeReg<CmdCtxTypesT::FlowParamsKey, BoxDt>

Type registry for FlowParams deserialization.

profile_to_flow_params: BTreeMap<Profile, FlowParams<CmdCtxTypesT::FlowParamsKey>>

Flow params for the selected flow.

profile_to_states_current_stored: BTreeMap<Profile, Option<StatesCurrentStored>>

Stored current states for each profile for the selected flow.

params_specs_type_reg: ParamsSpecsTypeReg

Type registry for each item’s Params::Spec.

This is used to deserialize ParamsSpecsFile.

profile_to_params_specs: BTreeMap<Profile, ParamsSpecs>

Item params specs for each profile for the selected flow.

states_type_reg: StatesTypeReg

Type registry for each item’s State.

This is used to deserialize StatesCurrentFile and StatesGoalFile.

resources: Resources<SetUp>

Resources for flow execution.

Implementations

impl<CmdCtxTypesT> CmdCtxMpsfFields<'_, CmdCtxTypesT>

where CmdCtxTypesT: CmdCtxTypes,

pub fn interruptibility_state(&mut self) -> InterruptibilityState<'_, '_>

Returns the interruptibility capability.

pub fn workspace(&self) -> &Workspace

Returns the workspace that the peace tool runs in.

pub fn workspace_dir(&self) -> &WorkspaceDir

Returns a reference to the workspace directory.

pub fn peace_dir(&self) -> &PeaceDir

Returns a reference to the .peace directory.

pub fn peace_app_dir(&self) -> &PeaceAppDir

Returns a reference to the .peace/$app directory.

pub fn profiles(&self) -> &[Profile]

Returns the accessible profiles.

These are the profiles that are filtered by the filter function, if provided.

pub fn profile_dirs(&self) -> &BTreeMap<Profile, ProfileDir>

Returns the profile directories keyed by each profile.

pub fn profile_history_dirs(&self) -> &BTreeMap<Profile, ProfileHistoryDir>

Returns the profile history directories keyed by each profile.

pub fn flow(&self) -> &Flow<CmdCtxTypesT::AppError>

Returns the flow.

pub fn flow_dirs(&self) -> &BTreeMap<Profile, FlowDir>

Returns the flow directories keyed by each profile.

pub fn workspace_params_type_reg( &self, ) -> &TypeReg<CmdCtxTypesT::WorkspaceParamsKey, BoxDt>

Returns a reference to the workspace params type registry.

pub fn workspace_params_type_reg_mut( &mut self, ) -> &mut TypeReg<CmdCtxTypesT::WorkspaceParamsKey, BoxDt>

Returns a mutable reference to the workspace params type registry.

pub fn workspace_params( &self, ) -> &WorkspaceParams<CmdCtxTypesT::WorkspaceParamsKey>

Returns the workspace params.

pub fn workspace_params_mut( &mut self, ) -> &mut WorkspaceParams<CmdCtxTypesT::WorkspaceParamsKey>

Returns the workspace params.

pub fn profile_params_type_reg( &self, ) -> &TypeReg<CmdCtxTypesT::ProfileParamsKey, BoxDt>

Returns a reference to the profile params type registry.

pub fn profile_params_type_reg_mut( &mut self, ) -> &mut TypeReg<CmdCtxTypesT::ProfileParamsKey, BoxDt>

Returns a mutable reference to the profile params type registry.

pub fn profile_to_profile_params( &self, ) -> &BTreeMap<Profile, ProfileParams<CmdCtxTypesT::ProfileParamsKey>>

Returns the profile params for each profile.

pub fn profile_to_profile_params_mut( &mut self, ) -> &mut BTreeMap<Profile, ProfileParams<CmdCtxTypesT::ProfileParamsKey>>

Returns the profile params for each profile.

pub fn flow_params_type_reg( &self, ) -> &TypeReg<CmdCtxTypesT::FlowParamsKey, BoxDt>

Returns a reference to the flow params type registry.

pub fn flow_params_type_reg_mut( &mut self, ) -> &mut TypeReg<CmdCtxTypesT::FlowParamsKey, BoxDt>

Returns a mutable reference to the flow params type registry.

pub fn profile_to_flow_params( &self, ) -> &BTreeMap<Profile, FlowParams<CmdCtxTypesT::FlowParamsKey>>

Returns the flow params for each profile.

pub fn profile_to_flow_params_mut( &mut self, ) -> &mut BTreeMap<Profile, FlowParams<CmdCtxTypesT::FlowParamsKey>>

Returns the flow params for each profile.

pub fn profile_to_states_current_stored( &self, ) -> &BTreeMap<Profile, Option<StatesCurrentStored>>

Returns the stored current states for each profile for the selected flow.

pub fn params_specs_type_reg(&self) -> &ParamsSpecsTypeReg

Returns the type registry for each item’s Params::Spec.

This is used to deserialize ParamsSpecsFile.

pub fn profile_to_params_specs(&self) -> &BTreeMap<Profile, ParamsSpecs>

Returns the item params specs for each profile for the selected flow.

pub fn states_type_reg(&self) -> &StatesTypeReg

Returns the type registry for each item’s State.

This is used to deserialize StatesCurrentFile and StatesGoalFile.

pub fn resources(&self) -> &Resources<SetUp>

Returns a reference to the Resources for flow execution.

pub fn resources_mut(&mut self) -> &mut Resources<SetUp>

Returns a reference to the Resources for flow execution.

Trait Implementations

impl<'ctx, CmdCtxTypesT> Debug for CmdCtxMpsfFields<'ctx, CmdCtxTypesT>

where CmdCtxTypesT: CmdCtxTypes + Debug, CmdCtxTypesT::AppError: Debug, CmdCtxTypesT::WorkspaceParamsKey: Debug, CmdCtxTypesT::ProfileParamsKey: Debug, CmdCtxTypesT::FlowParamsKey: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.