Struct ReadResult 

#[non_exhaustive]
pub struct ReadResult {
    pub recipe: Recipe,
    pub title: String,
    pub path: Option<Utf8PathBuf>,
}

A parsed recipe together with the title to display for it.

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.

recipe: Recipe

The parsed, scaled recipe.

title: String

The title to display for the recipe: its metadata title when it declares one, otherwise the file stem for a path or the caller-supplied name for in-memory text. Empty when none of those are known.

Formatters put this in markdown headings and in the name of schema.org output, so it is the recipe’s identity rather than a debug label — see CoreError::Parse’s name for the latter.

path: Option<Utf8PathBuf>

The file the recipe was read from, once resolved. None for RecipeSource::Content.

A bare name like pancakes can resolve to any of several directories and either extension, so the caller cannot reconstruct this. Callers that watch, reveal or write back the file they just read need it, and Diagnostic::location does not serve: a clean recipe produces no diagnostics at all.

Trait Implementations

impl Clone for ReadResult

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 ReadResult

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

Formats the value using the given formatter.