Struct ValidationReport 

#[non_exhaustive]
pub struct ValidationReport {
    pub base_dir: Utf8PathBuf,
    pub recipes: Vec<RecipeValidation>,
}

Everything validate found under one root.

The five totals the CLI prints are methods rather than fields. They hold nothing that recipes does not, and computing them on demand is what makes it impossible for a total to disagree with the recipes it counts.

#[non_exhaustive] because this is an output type consumers read rather than construct.

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.

base_dir: Utf8PathBuf

The root that was walked: ValidateRequest::base_dir, or the context’s base path when that was unset.

Carried so that a report is self-contained — every RecipeValidation::path is relative to this, and broken_references resolves against it without having to be told the root a second time and possibly told it wrong.

recipes: Vec<RecipeValidation>

Every recipe found under the root, clean ones included, in path order.

The order is this crate’s, not the walk’s: cooklang-find holds a directory’s entries in a HashMap, so the walk itself yields them in an order that changes between runs. Sorting makes a printed report diffable.

Implementations

impl ValidationReport

pub fn total_recipes(&self) -> usize

How many recipes were scanned, valid or not.

pub fn recipes_with_errors(&self) -> usize

How many recipes have at least one error.

pub fn recipes_with_warnings(&self) -> usize

How many recipes have at least one warning.

pub fn total_errors(&self) -> usize

How many errors there are in total, across every recipe.

pub fn total_warnings(&self) -> usize

How many warnings there are in total, across every recipe.

pub fn references(&self) -> BTreeMap<&Utf8Path, &[String]>

The references each recipe makes, keyed by recipe path, for callers that want to check them all at once. Recipes that reference nothing are left out entirely.

A view over RecipeValidation::references, borrowed rather than cloned, and ordered so that a caller reporting broken references reports them the same way twice running.

Nothing here has been resolved, and a reference that resolves to nothing raises no diagnostic, so it does not reach Outcome::diagnostics or has_errors either. Pass the report to broken_references to find out which of these lead anywhere.

Trait Implementations

impl Clone for ValidationReport

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationReport

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

Formats the value using the given formatter.