Struct PantryPlan 

#[non_exhaustive]
pub struct PantryPlan {
    pub steps: Vec<IngredientStep>,
    pub total_recipes: usize,
}

An order to stock a pantry in.

#[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.

steps: Vec<IngredientStep>

The ingredients to buy, most useful first.

total_recipes: usize

How many recipes the plan was worked out over: every recipe in the collection that lists at least one ingredient.

Implementations

impl PantryPlan

pub fn cookable_recipes(&self) -> usize

How many recipes are cookable once the whole plan is stocked.

Read off the last step rather than stored alongside it, so it cannot disagree with the steps it summarises. Zero for an empty plan.

pub fn coverage_percentage(&self) -> usize

cookable_recipes as a percentage of total_recipes, rounded down. Zero when there are no recipes at all.

Trait Implementations

impl Clone for PantryPlan

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 PantryPlan

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

Formats the value using the given formatter.

impl Eq for PantryPlan

impl PartialEq for PantryPlan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PantryPlan