Struct NextStep 

#[non_exhaustive]
pub struct NextStep {
    pub text: String,
    pub command: Option<String>,
}

A next-step action recommendation at the end of a report.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: String

command: Option<String>

Implementations

impl NextStep

pub fn new(text: impl Into<String>) -> Self

Creates a next step recommendation.

Examples found in repository

examples/report_demo.rs (line 60)

fn main() {
    let console = Console::stdout(ColorMode::Auto);

    println!("=== 1. Verdict & Status ===");
    println!(
        "{}",
        Verdict::Passed.render(console, "Configuration validated cleanly")
    );
    println!(
        "{}",
        Verdict::Warning.render(console, "3 non-critical findings detected")
    );
    println!(
        "{}",
        Verdict::Failed.render(console, "Build failed: 2 errors")
    );
    println!();

    println!("=== 2. Error / Prerequisite Block ===");
    let err_block = ErrorBlock::new("Required toolchain is unavailable")
        .with_explanation("The configured version is not installed.")
        .with_remedy("Install the required toolchain:")
        .add_command("toolchain install stable");
    print!("{}", err_block.render(console));

    println!("=== 3. Decision-Oriented Report (Compact) ===");
    let report = Report::new("Site audit v1.2.0", Verdict::Warning)
        .add_scope_note(ScopeNote::new(
            "Scope warnings",
            vec![
                "Git history partial".to_string(),
                "1 file skipped".to_string(),
            ],
        ))
        .add_metric(Metric::new("Errors", "0"))
        .add_metric(Metric::new("Warnings", "4").with_trend(runemark::Trend::Negative, "+2"))
        .add_metric(Metric::new("Score", "94/100").with_trend(runemark::Trend::Positive, "+5%"))
        .add_group(
            FindingGroup::new("Accessibility Violations")
                .add_finding(
                    Finding::new(runemark::Tone::Warning, "Image missing alt attribute")
                        .with_rule_id("a11y/img-alt")
                        .with_badge(runemark::Badge::quick_win())
                        .with_confidence(runemark::Confidence::High)
                        .with_location(Location::file_line_col("src/pages/index.astro", 42, 10))
                        .with_remedy("Add alt=\"...\" description to <img> tag"),
                )
                .add_finding(
                    Finding::new(runemark::Tone::Warning, "Low contrast ratio on hero button")
                        .with_rule_id("a11y/contrast")
                        .with_location(Location::file_line("src/components/Hero.astro", 18)),
                ),
        )
        .add_next_step(
            NextStep::new("Run auto-fixer for formatting issues").with_command("audit --fix"),
        );

    print!("{}", report.render(console));

    println!("=== 4. Detailed Report View ===");
    let detailed_report = report.with_detail_level(DetailLevel::Detailed);
    print!("{}", detailed_report.render(console));

    println!("=== 5. Generator Diff View ===");
    let diff = DiffBlock::new()
        .add_change(
            FileChange::new(FileAction::Added, "src/components/Footer.astro").with_delta("+1.2 kB"),
        )
        .add_change(FileChange::new(
            FileAction::Modified,
            "src/layouts/Layout.astro",
        ))
        .add_change(FileChange::new(
            FileAction::Deleted,
            "src/legacy/Footer.jsx",
        ));
    print!("{}", diff.render(console));
}

pub fn with_command(self, command: impl Into<String>) -> Self

Attaches a copyable command.

Examples found in repository

examples/report_demo.rs (line 60)

fn main() {
    let console = Console::stdout(ColorMode::Auto);

    println!("=== 1. Verdict & Status ===");
    println!(
        "{}",
        Verdict::Passed.render(console, "Configuration validated cleanly")
    );
    println!(
        "{}",
        Verdict::Warning.render(console, "3 non-critical findings detected")
    );
    println!(
        "{}",
        Verdict::Failed.render(console, "Build failed: 2 errors")
    );
    println!();

    println!("=== 2. Error / Prerequisite Block ===");
    let err_block = ErrorBlock::new("Required toolchain is unavailable")
        .with_explanation("The configured version is not installed.")
        .with_remedy("Install the required toolchain:")
        .add_command("toolchain install stable");
    print!("{}", err_block.render(console));

    println!("=== 3. Decision-Oriented Report (Compact) ===");
    let report = Report::new("Site audit v1.2.0", Verdict::Warning)
        .add_scope_note(ScopeNote::new(
            "Scope warnings",
            vec![
                "Git history partial".to_string(),
                "1 file skipped".to_string(),
            ],
        ))
        .add_metric(Metric::new("Errors", "0"))
        .add_metric(Metric::new("Warnings", "4").with_trend(runemark::Trend::Negative, "+2"))
        .add_metric(Metric::new("Score", "94/100").with_trend(runemark::Trend::Positive, "+5%"))
        .add_group(
            FindingGroup::new("Accessibility Violations")
                .add_finding(
                    Finding::new(runemark::Tone::Warning, "Image missing alt attribute")
                        .with_rule_id("a11y/img-alt")
                        .with_badge(runemark::Badge::quick_win())
                        .with_confidence(runemark::Confidence::High)
                        .with_location(Location::file_line_col("src/pages/index.astro", 42, 10))
                        .with_remedy("Add alt=\"...\" description to <img> tag"),
                )
                .add_finding(
                    Finding::new(runemark::Tone::Warning, "Low contrast ratio on hero button")
                        .with_rule_id("a11y/contrast")
                        .with_location(Location::file_line("src/components/Hero.astro", 18)),
                ),
        )
        .add_next_step(
            NextStep::new("Run auto-fixer for formatting issues").with_command("audit --fix"),
        );

    print!("{}", report.render(console));

    println!("=== 4. Detailed Report View ===");
    let detailed_report = report.with_detail_level(DetailLevel::Detailed);
    print!("{}", detailed_report.render(console));

    println!("=== 5. Generator Diff View ===");
    let diff = DiffBlock::new()
        .add_change(
            FileChange::new(FileAction::Added, "src/components/Footer.astro").with_delta("+1.2 kB"),
        )
        .add_change(FileChange::new(
            FileAction::Modified,
            "src/layouts/Layout.astro",
        ))
        .add_change(FileChange::new(
            FileAction::Deleted,
            "src/legacy/Footer.jsx",
        ));
    print!("{}", diff.render(console));
}

Trait Implementations

impl Clone for NextStep

fn clone(&self) -> NextStep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NextStep

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

Formats the value using the given formatter.

impl Eq for NextStep

impl PartialEq for NextStep

fn eq(&self, other: &NextStep) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for NextStep