Struct Step

pub struct Step {
    text: String,
    resources: Vec<Resource>,
    all_sub_steps: Vec<SubStep>,
}

Each Step struct contains all Actions, Images, Commands, Resources, Verifications, and Warnings contained in that step

Fields

text: String

Text of the step, analogous to the Title of a Section except at the Step-level

resources: Vec<Resource>

Ordered set of Resources identified in the Step, wherever they are mentioned

all_sub_steps: Vec<SubStep>

Ordered set of SubSteps identified, be them sets of Action lines, Commands, Warnings, or Verification events

Note: Resources are not included as SubSteps themselves, although other lines within a Step are

Implementations

impl Step

Step needs “get” and “set/add” functions as well, to read and write private fields

pub fn new() -> Step

Empty string for the Step text, and empty vectors for ‘resources’ and ‘all_sub_steps’

pub fn get_text(&self) -> &String

Return reference to Step text as string

pub fn get_resources(&self) -> &Vec<Resource>

Return reference to Vector of Resource structs for this step

pub fn get_all_sub_steps(&self) -> &Vec<SubStep>

Return reference to Vector of SubStep structs for all SubSteps in this Step

fn set_text(&mut self, text: &str)

Change the text of this Step

fn add_sub_step(&mut self, sub_step: SubStep)

Add a complete SubStep to the ordered Vector of SubStep structs

fn add_resource(&mut self, r: Resource)

Add a complete Resource struct to the ordered Vector of Resource structs