Enum StepKind 

#[non_exhaustive]
pub enum StepKind {
    Symlink {
        src: PathBuf,
        dst: PathBuf,
        kind: SymlinkKind,
        backup: bool,
        normalize: bool,
    },
    Unlink {
        dst: PathBuf,
    },
    Env {
        name: String,
        value: String,
        scope: EnvScope,
    },
    Mkdir {
        path: PathBuf,
        mode: Option<String>,
    },
    Rmdir {
        path: PathBuf,
        backup: bool,
        force: bool,
    },
    Require {
        outcome: PredicateOutcome,
        on_fail: RequireOnFail,
    },
    When {
        branch_taken: bool,
        nested_steps: Vec<ExecStep>,
    },
    Exec {
        cmdline: String,
        cwd: Option<PathBuf>,
        on_fail: ExecOnFail,
        shell: bool,
    },
    PackSkipped {
        actions_hash: String,
    },
}

Variant-specific detail for a recorded step.

Paths are PathBuf rather than String because after expansion every path field is a concrete OS path. Command lines remain String because argv joining for display is lossy by design — the wet-run executor re-reads the underlying crate::pack::ExecSpec when spawning.

Marked #[non_exhaustive] so the M4 plugin layer can contribute new step-detail shapes without breaking downstream renderers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Symlink

Resolved symlink descriptor.

Fields

src: PathBuf

Post-expansion source path.

dst: PathBuf

Post-expansion destination path.

kind: SymlinkKind

Link-kind selector, passed through from the action.

backup: bool

Whether an existing dst would be backed up.

normalize: bool

Whether both sides would be canonicalised.

Unlink

Resolved unlink descriptor — synthesized inverse of StepKind::Symlink for auto-reverse teardown (R-M5-09).

Fields

dst: PathBuf

Post-expansion destination path to remove.

Env

Resolved environment-variable assignment.

Fields

name: String

Variable name (not expanded).

value: String

Post-expansion value.

scope: EnvScope

Persistence scope.

Mkdir

Resolved mkdir descriptor.

Fields

path: PathBuf

Post-expansion path.

mode: Option<String>

Optional POSIX mode string, verbatim.

Rmdir

Resolved rmdir descriptor.

Fields

path: PathBuf

Post-expansion path.

backup: bool

Whether to rename instead of delete.

force: bool

Whether recursive delete is permitted.

Require

Resolved require gate.

Fields

outcome: PredicateOutcome

Whether the predicate tree held.

on_fail: RequireOnFail

Behaviour configured for unsatisfied outcomes.

When

Resolved when gate.

Fields

branch_taken: bool

Whether the composite condition evaluated to true.

nested_steps: Vec<ExecStep>

Nested planned steps when branch_taken == true. Empty otherwise.

Exec

Resolved exec descriptor.

Fields

cmdline: String

Display-friendly command line (argv joined or cmd_shell verbatim).

cwd: Option<PathBuf>

Post-expansion working directory, when set.

on_fail: ExecOnFail

Error-propagation policy.

shell: bool

Whether this is a shell form.

PackSkipped

Dedicated pack-level skip detail. Emitted when a pack’s actions_hash matches a prior lockfile entry and the sync layer short-circuits the entire pack. Replaces the M4-B proxy of Require { Satisfied, Skip } with action_name == "pack".

Fields

actions_hash: String

Actions-hash that matched the lockfile entry for this pack.

Trait Implementations

impl Clone for StepKind

fn clone(&self) -> StepKind

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StepKind

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

Formats the value using the given formatter.