Struct Context 

pub struct Context { /* private fields */ }

The configuration bundle every command operates against.

Context::new performs no filesystem access. Ambient configuration discovery is opt-in through Context::discover, so a caller that already knows its configuration — an editor holding an unsaved buffer, say — never has the user’s ~/.config read behind its back.

Implementations

impl Context

pub fn new(base_path: Utf8PathBuf) -> Self

A context with no aisle or pantry configuration. Touches nothing.

pub fn discover(base_path: Utf8PathBuf) -> Self

A context with aisle and pantry resolved using CookCLI’s search order: <base>/config/<name> first, then the global configuration directory (global_config_path — $COOK_CONFIG_DIR when set, otherwise ~/.config/cook/<name> on Linux and the platform equivalent elsewhere).

This is the only constructor that reads ambient state, and it is explicitly opted into.

Two things to know before relying on it:

• It reports no errors. A configuration directory that cannot be resolved at all — no home directory, or a non-UTF-8 path — is treated as one fewer place to look, exactly as the CLI treats it. An unset ConfigSource therefore does not distinguish “the user has no config file” from “this machine has no home directory”. Call global_config_path directly if you need to tell those apart.
• It stats, it does not read. Discovery only checks that each candidate is a file; the contents are read later by ConfigSource::read. A Context held across an editing session can therefore name a file that has since been deleted, which surfaces as a CoreError::Io from whichever command reads it rather than from here. Re-run discover if the configuration may have changed.

pub fn with_aisle(self, source: ConfigSource) -> Self

Replace the aisle configuration, whatever discovery found.

pub fn with_pantry(self, source: ConfigSource) -> Self

Replace the pantry configuration, whatever discovery found.

pub fn base_path(&self) -> &Utf8Path

The directory recipe paths and searches are resolved against.

Returned exactly as it was supplied. Unlike the CLI, which canonicalises it and rejects a non-directory before building a Context, core neither resolves nor validates it — so a relative path is interpreted against the process working directory, which for an in-process editor integration is the editor’s, not the project’s. Pass an absolute path unless you mean that.

pub fn aisle(&self) -> &ConfigSource

The aisle configuration to categorise shopping list ingredients with.

pub fn pantry(&self) -> &ConfigSource

The pantry configuration to filter already-stocked ingredients with.

Trait Implementations

impl Clone for Context

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 Context

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

Formats the value using the given formatter.