Struct StepSpec 

pub struct StepSpec {
    pub name: &'static str,
    pub chapter: &'static str,
    pub mutates: Mutates,
    pub proves: &'static str,
    pub destructive: bool,
    pub optional: bool,
    pub prereqs: &'static [&'static str],
}

One step of the setup, in canonical order.

Fields

name: &'static str

The name, which is also the rk setup step argument and the script file name in every forge tree.

chapter: &'static str

The method/02-setup.md section the step executes.

mutates: Mutates

What the step touches under apply.

proves: &'static str

What the step proves, from the chapter.

destructive: bool

Whether the step deletes anything; a destructive step carries its own refusal beyond --apply.

optional: bool

Whether a full run skips the step: an optional step applies only where its condition holds, by name, through rk setup step.

prereqs: &'static [&'static str]

Steps that must be observed satisfied before this one applies.

Trait Implementations

impl Debug for StepSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.