Trait WorkflowStep

pub trait WorkflowStep {
    // Required methods
    fn get_status(&self) -> &StepStatus;
    fn get_definition(&self) -> &WorkflowStepDefinition;
    fn execute(&mut self, inputs: &mut StepInputs, outputs: &mut StepOutputs);
    fn shutdown(&mut self);
}

Represents a workflow step that can be executed

Required Methods

fn get_status(&self) -> &StepStatus

Returns a reference to the status of the current workflow step

fn get_definition(&self) -> &WorkflowStepDefinition

Returns a reference to the definition this workflow step was created with

fn execute(&mut self, inputs: &mut StepInputs, outputs: &mut StepOutputs)

Executes the workflow step with the specified media and future resolution inputs. Any outputs that are generated as a result of this execution will be placed in the outputs parameter, to allow vectors to be re-used.

It is expected that execute() will not be called if the step is in an Error or Torn Down state.

fn shutdown(&mut self)

Notifies the step that it is no longer needed and that all streams its managing should be closed. All endpoints the step has interacted with should be proactively notified that it is being removed, as it can not be guaranteed that all channels will be automatically closed.

After this is called it is expected that the workflow step is in a TornDown state.

Implementors