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 forge_cli: &'static [Forge],
    pub prereqs: &'static [&'static str],
    pub applies: Applies,
}

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.

forge_cli: &'static [Forge]

The forges at which the step reaches the forge through its CLI.

Empty where the step is local work alone. A forge absent from the list is one this step answers without a call, which forge-version does on GitHub: a rolling service declares no version floor, so there is nothing to read. A run that reaches the CLI for a step that never calls it refuses an operator who has no reason to need one.

prereqs: &'static [&'static str]

Steps that must be observed satisfied before this one applies.

applies: Applies

Why this step does not apply to a target, or None where it does.

Trait Implementations

impl Debug for StepSpec

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

Formats the value using the given formatter.