Enum Error 

pub enum Error {
    RecipeParseError(SourceReport),
    TemplateError(Error),
}

Error type for this crate.

Variants

RecipeParseError(SourceReport)

An error occurred when parsing the recipe.

TemplateError(Error)

An error occurred when generating a report from a template.

Implementations

impl Error

pub fn format_with_source(&self) -> String

Format the error with full context including source chain and helpful hints

This method provides comprehensive error formatting that includes:

• The main error message
• The complete chain of error causes
• Template-specific context for common errors
• Helpful suggestions for fixing the error

Returns

A formatted string suitable for display to end users with detailed error information.

Example

use cooklang_reports::render_template;

let recipe = "@eggs{2}";
let template = "{% for item in ingredients %}{{ item.name }}{% endfor"; // Missing %}

match render_template(recipe, template) {
    Ok(result) => println!("{}", result),
    Err(err) => {
        // This will print detailed error information including:
        // - The syntax error
        // - Line and column information
        // - Suggestions for fixing missing closing tags
        eprintln!("{}", err.format_with_source());
    }
}

Output Format

The output includes:

• Primary error message with debug info (line numbers, source context)
• Caused by chain (if any)
• Additional details from minijinja
• Context-specific help for common template errors

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<SourceReport> for Error

fn from(source: SourceReport) -> Self

Converts to this type from the input type.