Struct subplotlib::prelude::ScenarioStep

pub struct ScenarioStep { /* private fields */ }

A ScenarioStep is one step in a scenario.

In essence, a scenario step is a named closure. Its name can be used when reporting an error encountered in running a scenario.

Scenario steps are typically constructed from step builders, rather than directly. This permits the step builder to correctly register context types etc.

let step = ScenarioStep::new(
    "when everything works".to_string(), |ctx, ok| Ok(()), |scen| (), "unknown"
);

Implementations

impl ScenarioStep

pub fn new<F, R>( step_text: String, func: F, reg: R, location: &'static str ) -> Selfwhere F: Fn(&ScenarioContext, bool) -> StepResult + 'static, R: Fn(&Scenario) + 'static,

Create a new scenario step taking the scenario context

This is used to construct a scenario step from a function which takes the scenario context container. This will generally be called from the generated build method for the step.

pub fn call(&self, context: &ScenarioContext, defuse_poison: bool) -> StepResult

Call the step function

This simply calls the encased step function

pub fn step_text(&self) -> &str

Return the full text of this step