Struct stepflow::step::Step [−][src]
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
[src]
pub fn new(
id: StepId,
input_vars: Option<Vec<VarId, Global>>,
output_vars: Vec<VarId, Global>
) -> Step
[src]
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>>
[src]
pub fn get_output_vars(&self) -> &Vec<VarId, Global>
[src]
pub fn push_substep(&mut self, substep_step_id: StepId)
[src]
Push a substep to the end of the current sub-steps
pub fn next_substep(&self, prev_substep_id: &StepId) -> Option<&StepId>
[src]
Get the sub-step that directly follows prev_substep_id
pub fn first_substep(&self) -> Option<&StepId>
[src]
pub fn can_enter(&self, inputs: &StateData) -> Result<(), IdError<VarId>>
[src]
Verifies that inputs
fulfills the required inputs to enter the step
pub fn can_exit(&self, state_data: &StateData) -> Result<(), IdError<VarId>>
[src]
Verifies that state_data
fulfills the required outputs to exit the step
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Step
impl Send for Step
impl Sync for Step
impl Unpin for Step
impl UnwindSafe for Step
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> AsAny for T where
T: Any,
[src]
T: Any,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,