Struct RenderRequest 

pub struct RenderRequest {
    pub source: RecipeSource,
    pub template: String,
    pub scale: f64,
    pub datastore: Option<Utf8PathBuf>,
    pub base_path: Option<Utf8PathBuf>,
}

A report to render.

Fields

source: RecipeSource

The recipe to render.

template: String

The template text itself, not a path to it.

Reading a .jinja off disk is the caller’s job, which is what lets a caller holding one in a buffer pass it straight in. Nothing is lost by taking the text: cooklang-reports registers this as the environment’s only template and configures no loader, so {% include %} and {% extends %} have nothing to resolve against either way.

scale: f64

Scaling factor. Pass 1.0 to leave quantities alone.

Reaches the template as the scale variable and scales the recipe, so a template printing {{ scale }} alongside its quantities stays consistent. As in ReadRequest::scale, CookCLI’s name:factor spelling is a command-line convention: callers split it themselves with split_name_and_scale.

datastore: Option<Utf8PathBuf>

Directory of the YAML datastore the db() template function reads.

None leaves db() unusable; a template that calls it then fails with CoreError::Render. A path that does not exist is not an error here — cooklang-reports reports a key it cannot find by warning on stderr and substituting an empty string.

base_path: Option<Utf8PathBuf>

Directory that recipe references inside the template resolve against, and that a RecipeSource::Path is looked up under.

Defaults to Context::base_path. It also reaches the template as the base_path variable. Unlike the CLI, nothing here makes it absolute: a relative path is interpreted against the process working directory.

Trait Implementations

impl Clone for RenderRequest

fn clone(&self) -> RenderRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderRequest

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

Formats the value using the given formatter.