Struct RecipeValidation 

#[non_exhaustive]
pub struct RecipeValidation {
    pub path: Utf8PathBuf,
    pub diagnostics: Vec<Diagnostic>,
    pub rendered: String,
    pub references: Vec<String>,
}

What validating one recipe found.

#[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.

path: Utf8PathBuf

Where the recipe sits under the validation root.

Always relative to that root, and the same path diagnostics and rendered name. cooklang-find takes every path relative to the root while building the tree, and fails the whole walk if it cannot, so there is no way for an absolute path to reach this field.

diagnostics: Vec<Diagnostic>

Every problem the parser raised, errors and warnings alike, in the order the parser produced them. Empty for a recipe with nothing wrong with it.

A recipe that could not be read at all carries a single error diagnostic saying so, rather than dropping out of the report.

rendered: String

The parser’s own multi-line report, with the offending source lines quoted, ready to print verbatim. Empty exactly when diagnostics is — except for a recipe that could not be read, which has a diagnostic but no source to quote, so nothing to render.

Carries ANSI escape codes when ValidateRequest::style is Style::Ansi, and none when it is Style::Plain. This is the one difference from CoreError::Parse::rendered, which is always plain.

references: Vec<String>

The recipes this one references, spelled as they are written in it — ./sauce, say. In source order, with a recipe referenced twice listed twice.

Nothing here has been resolved: a name in this list need not exist, and checking that is the caller’s job. Empty for a recipe with errors, since cooklang produces no recipe to read them off — so a broken recipe’s references go unchecked rather than being reported as missing. A warning does not do that: a textual timer quantity is a warning, and the recipe is still produced, so its references are checked.

Trait Implementations

impl Clone for RecipeValidation

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 RecipeValidation

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

Formats the value using the given formatter.