Struct IngredientCoverage 

#[non_exhaustive]
pub struct IngredientCoverage {
    pub total_recipes: usize,
    pub ingredients: Vec<CheckedIngredient>,
}

How much of a collection’s ingredients a configuration accounts for.

The two views callers want — what is covered and what is not — are known and unknown, derived from ingredients rather than stored beside it, so that they cannot disagree with it or with each other.

#[non_exhaustive] because this is an output type consumers read rather than construct.

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.

total_recipes: usize

How many recipes were scanned, including any that could not be read or parsed — those contribute no ingredients, and say so in Outcome::diagnostics.

ingredients: Vec<CheckedIngredient>

Every distinct ingredient the collection uses, each marked with whether the configuration knows it.

Ordered by Unicode code point rather than alphabetically, so every capitalised name sorts before every lowercase one: Beetroot, Zucchini, apple. That is what CookCLI has always printed, and changing it would move output nobody asked to have moved — a consumer wanting a human ordering should sort these itself.

References to other recipes are not ingredients and are left out.

Implementations

impl IngredientCoverage

pub fn total_ingredients(&self) -> usize

How many distinct ingredients the collection uses.

pub fn known(&self) -> impl Iterator<Item = &str>

The ingredients the configuration knows, in the order of ingredients.

pub fn unknown(&self) -> impl Iterator<Item = &str>

The ingredients the configuration does not know, in the order of ingredients.

With no configuration at all this is every ingredient, since nothing is known. Ask ConfigSource::is_unset if you need to tell that from a configuration that simply covers nothing.

pub fn known_entries(&self) -> impl Iterator<Item = &CheckedIngredient>

As known, but keeping each ingredient whole — its recipes along with its name.

pub fn unknown_entries(&self) -> impl Iterator<Item = &CheckedIngredient>

As unknown, but keeping each ingredient whole — its recipes along with its name.

This is the view that answers “which recipes do I have to go and fix?”: an uncategorised ingredient is usually a misspelling of a categorised one, and the recipes listed against it are where that misspelling is.

Trait Implementations

impl Clone for IngredientCoverage

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 IngredientCoverage

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

Formats the value using the given formatter.

impl Default for IngredientCoverage

fn default() -> Self

Returns the “default value” for a type.

impl Eq for IngredientCoverage

impl PartialEq for IngredientCoverage

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for IngredientCoverage