Enum CoreError 

#[non_exhaustive]
pub enum CoreError {
    RecipeNotFound {
        name: String,
    },
    Parse {
        name: String,
        diagnostics: Vec<Diagnostic>,
        rendered: String,
    },
    InvalidScale {
        scale: f64,
    },
    MissingConfig {
        kind: String,
    },
    ReadOnlyConfig {
        kind: String,
    },
    Config {
        path: Option<Utf8PathBuf>,
        message: String,
    },
    PantryEdit {
        message: String,
    },
    Render {
        message: String,
        rendered: String,
    },
    Reference {
        name: String,
        message: String,
    },
    Search {
        base_dir: Utf8PathBuf,
        message: String,
    },
    InvalidShoppingList {
        path: Utf8PathBuf,
        message: String,
    },
    Io {
        path: Utf8PathBuf,
        source: Error,
    },
}

Errors returned by cookcli-core commands.

Every Display rendering is a single lowercase line with no trailing newline, so it composes into log lines and error chains. Variants that have a longer, human-formatted report carry it in a field for the caller to print separately.

#[non_exhaustive] so that adding variants stays non-breaking for downstream consumers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

RecipeNotFound

No recipe could be resolved from the given path or name.

Fields

name: String

The path or name that was looked up.

Parse

A recipe failed to parse.

Fields

name: String

How the recipe is identified in messages. Commands reading from disk put the file’s path here, so that it agrees with the location rendered and the diagnostics point at; text parsed from memory carries whatever name the caller supplied.

diagnostics: Vec<Diagnostic>

The individual parse problems, for programmatic consumers.

rendered: String

The parser’s own multi-line report with source line context, which the CLI prints verbatim. Not part of Display.

Always free of ANSI escape codes, so it is safe to write to a file or send over a wire. Callers wanting colour for a terminal should re-render with render_report and ansi: true.

InvalidScale

A scaling factor was not a finite number.

Only NaN and infinity are rejected. Zero and negative factors are accepted, because the CLI accepts them and this crate must not change that behaviour. NaN is worth catching because a missing JavaScript argument arrives as undefined, which becomes NaN across NAPI and would otherwise silently produce NaN quantities.

Fields

scale: f64

The rejected factor.

MissingConfig

A command needed a configuration the context does not carry.

Distinct from CoreError::Config, which means one was supplied and could not be understood. Not every command needs one: shopping_list::generate treats an absent pantry as “subtract nothing”, where the pantry queries cannot, because the pantry is the thing they report on.

Fields

kind: String

Which configuration is missing, as it is named to the user: "pantry" is the only one anything returns today.

ReadOnlyConfig

A command that changes a configuration was handed one it cannot write back.

Reached only through ConfigSource::Inline: an editor holding pantry text in a buffer has somewhere to put an edit, but this crate has no idea where. Applying the change is the caller’s to do, or it can supply a ConfigSource::Path instead.

Distinct from CoreError::MissingConfig, which is having nothing to change at all.

Fields

kind: String

Which configuration, as it is named to the user: "pantry" is the only one anything returns today.

Config

A configuration could not be understood.

Fields

path: Option<Utf8PathBuf>

The file the configuration came from, absent when it was supplied inline.

message: String

What was wrong with it.

PantryEdit

A pantry could not be changed as asked.

The file was read and understood; it is the change that does not apply — adding an item that is already there, or naming an item or section that is not. Distinct from CoreError::Config, which is a file that could not be read as a pantry at all, and from CoreError::Io, which is a file that could not be read or written.

Nothing has been written when this is returned: every check runs before the pantry is saved.

Fields

message: String

What stopped the change, naming the item and section it was asked about.

Render

A report could not be produced from a template and a recipe.

Covers a broken template and a recipe cooklang-reports could not parse alike, because that crate parses the recipe itself, with its own parser configuration, from inside the render call — the two failures arrive down one channel and are not worth guessing apart. A recipe that fails core’s own parser still yields CoreError::Parse; it is only report::render that reports both this way.

Fields

message: String

A one-line summary, for logs and error chains.

rendered: String

The template engine’s own multi-line report — source location, error chain, and its hints — which the CLI prints verbatim. Not part of Display, exactly as CoreError::Parse’s rendered is not.

Reference

A recipe reference could not be expanded into its ingredients.

The referenced recipe was found and parsed; what failed was working out how much of it the referring recipe wants — an unusable quantity on the reference, or a target the referenced recipe cannot be scaled to. Absence and parse failures are CoreError::RecipeNotFound and CoreError::Parse as usual.

Fields

name: String

The referenced recipe, as it is spelled in the referring recipe.

message: String

What went wrong.

Search

A directory could not be searched.

Distinct from CoreError::Io because nothing was read: the search root itself could not be turned into something searchable, so the walk never started. A root whose name contains glob syntax — notes[2024] — is the way to reach this, since cooklang-find builds its file pattern by joining onto the root without escaping it. Reporting that as a failed read would send the user looking at permissions.

Fields

base_dir: Utf8PathBuf

The directory that could not be searched.

message: String

What went wrong with it.

InvalidShoppingList

A saved shopping list could not be read as one.

The .shopping-list file was read; it is its contents that could not be parsed. Distinct from CoreError::Io, which is the file itself being unreadable, and from CoreError::Parse, which is a recipe.

Reachable because the file is a plain text format users and other Cooklang apps edit directly, so this crate is not the only thing that writes it.

Fields

path: Utf8PathBuf

The shopping list that could not be parsed.

message: String

What was wrong with it, as the format parser reported it.

Io

A file could not be read or written.

There is deliberately no From<std::io::Error>: every call site must name the path it was working on. The message stays neutral between reading and writing, because the variant covers both; the specific failure is in source.

Fields

path: Utf8PathBuf

The file being accessed.

source: Error

The underlying operating system error.

Trait Implementations

impl Debug for CoreError

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

Formats the value using the given formatter.

impl Display for CoreError

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

Formats the value using the given formatter.

impl Error for CoreError

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.