Struct stepflow::step::Step

pub struct Step {
    pub id: StepId,
    pub input_vars: Option<Vec<VarId, Global>>,
    pub output_vars: Vec<VarId, Global>,
    // some fields omitted
}

A single step in a flow

A step is defined by its the required inputs to enter the step and the outputs it must fulfill to exit the step. Substeps allow for grouping of steps and are executing in order by default.

Fields

id: StepId

input_vars: Option<Vec<VarId, Global>>

output_vars: Vec<VarId, Global>

Implementations

impl Step

pub fn new(
    id: StepId,
    input_vars: Option<Vec<VarId, Global>>,
    output_vars: Vec<VarId, Global>
) -> Step

Create a new step.

If no inputs are required, pass in None for input_vars

pub fn get_input_vars(&self) -> &Option<Vec<VarId, Global>>

pub fn get_output_vars(&self) -> &Vec<VarId, Global>

pub fn push_substep(&mut self, substep_step_id: StepId)

Push a substep to the end of the current sub-steps

pub fn next_substep(&self, prev_substep_id: &StepId) -> Option<&StepId>

Get the sub-step that directly follows prev_substep_id

pub fn first_substep(&self) -> Option<&StepId>

pub fn can_enter(&self, inputs: &StateData) -> Result<(), IdError<VarId>>

Verifies that inputs fulfills the required inputs to enter the step

pub fn can_exit(&self, state_data: &StateData) -> Result<(), IdError<VarId>>

Verifies that state_data fulfills the required outputs to exit the step

Trait Implementations

impl Debug for Step

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

Formats the value using the given formatter.

impl ObjectStoreContent for Step

type IdType = StepId

pub fn new_id(id_val: u16) -> <Step as ObjectStoreContent>::IdType

pub fn id(&self) -> &<Step as ObjectStoreContent>::IdType