Struct StepResult 

pub struct StepResult {
    pub label: String,
    pub status: StepStatus,
    pub detail: String,
}

Fields

label: String

status: StepStatus

detail: String

Implementations

impl StepResult

pub fn ok(label: impl Into<String>) -> Self

Ok with an empty detail — the most common shape (the step label alone says everything the user needs).

pub fn ok_with_detail( label: impl Into<String>, detail: impl Into<String>, ) -> Self

Ok with an explanatory detail line (e.g. “copied from ”). Kept as a distinct constructor rather than overloading ok(label, detail) so the “no detail by default” semantics of ok stay unambiguous at the call sites.

pub fn skipped(label: impl Into<String>, reason: impl Into<String>) -> Self

Skipped with the reason the step was bypassed (e.g. “destination already exists”, “when condition false”).

pub fn warning(label: impl Into<String>, message: impl Into<String>) -> Self

Warning with the user-visible message. Used by guards substituting from .env.example and the no-symlink remediation path — the step proceeded but the user should know what changed.

pub fn failed(label: impl Into<String>, message: impl Into<String>) -> Self

Failed with the user-visible error detail. The detail SHOULD include enough context for the user to fix the problem without re-running with extra verbosity (filename, errno, guard name).

Trait Implementations

impl Clone for StepResult

fn clone(&self) -> StepResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StepResult

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

Formats the value using the given formatter.