Trait stepflow::prelude::Action

pub trait Action: Debug + AsAny {
    pub fn id(&self) -> &ActionId;
    pub fn start(
        &mut self, 
        step: &Step, 
        step_name: Option<&str>, 
        step_data: &StateDataFiltered<'_>, 
        vars: &ObjectStoreFiltered<'_, Box<dyn Var + 'static + Sync + Send, Global>, VarId>
    ) -> Result<ActionResult, ActionError>;
}

Actions fulfill the outputs of a Step

Required methods

pub fn id(&self) -> &ActionId

Get the ID for the Action

pub fn start(
    &mut self,
    step: &Step,
    step_name: Option<&str>,
    step_data: &StateDataFiltered<'_>,
    vars: &ObjectStoreFiltered<'_, Box<dyn Var + 'static + Sync + Send, Global>, VarId>
) -> Result<ActionResult, ActionError>

Start the action for a Step

step_data and vars only have access to input and output data declared by the Step.

Loading content...

Implementations

impl dyn Action + 'static + Sync + Send

pub fn downcast<T>(&self) -> Option<&T> where
    T: Action + Any, 

pub fn is<T>(&self) -> bool where
    T: Action + Any, 

Implementors

impl Action for HtmlFormAction

pub fn id(&self) -> &ActionId

pub fn start(
    &mut self,
    step: &Step,
    _step_name: Option<&str>,
    _step_data: &StateDataFiltered<'_>,
    vars: &ObjectStoreFiltered<'_, Box<dyn Var + 'static + Sync + Send, Global>, VarId>
) -> Result<ActionResult, ActionError>

impl Action for SetDataAction

pub fn id(&self) -> &ActionId

pub fn start(
    &mut self,
    _step: &Step,
    _step_name: Option<&str>,
    _step_data: &StateDataFiltered<'_>,
    _vars: &ObjectStoreFiltered<'_, Box<dyn Var + 'static + Sync + Send, Global>, VarId>
) -> Result<ActionResult, ActionError>

impl<T> Action for StringTemplateAction<T> where
    T: EscapedString, 

pub fn id(&self) -> &ActionId

pub fn start(
    &mut self,
    step: &Step,
    step_name: Option<&str>,
    _step_data: &StateDataFiltered<'_>,
    _vars: &ObjectStoreFiltered<'_, Box<dyn Var + 'static + Sync + Send, Global>, VarId>
) -> Result<ActionResult, ActionError>

Loading content...