Struct PantryItem 

#[non_exhaustive]
pub struct PantryItem {
    pub name: String,
    pub section: String,
    pub quantity: Option<String>,
    pub bought: Option<String>,
    pub expire: Option<String>,
    pub low: Option<String>,
}

One item in the pantry.

Every field is carried as it was written, without interpretation: a quantity is "500%g" rather than a number and a unit, and a date is whatever spelling the file used. The methods below are where interpretation happens.

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

name: String

The ingredient’s name, as written.

section: String

The section it was written under. cooklang collects items written above the first section header into a section called general, so an item always has one.

quantity: Option<String>

How much is in stock — "500%g", "2" — or None for an item written without a quantity.

bought: Option<String>

When it was bought, if the file says.

expire: Option<String>

When it expires, if the file says. See expiring for the spellings that can be read as a date.

low: Option<String>

The quantity at or below which this item counts as low, if the file sets one. See is_low.

Implementations

impl PantryItem

pub fn is_low(&self) -> bool

True when the stock has fallen to or below this item’s own low threshold.

False unless quantity and low are both set, both parse as a number with an optional unit, and those units are equal: a threshold written in different units from the stock is not compared, and neither is a quantity that is not a number. Such an item is not “not low” so much as unanswerable, and depleted falls back to its built-in thresholds for it.

Computed rather than stored, so it cannot disagree with the fields it reads. The comparison is cooklang’s own, reached by handing it an equivalent item, so that there is one definition of it rather than two that can drift.

Trait Implementations

impl Clone for PantryItem

fn clone(&self) -> PantryItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PantryItem

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

Formats the value using the given formatter.

impl Eq for PantryItem

impl PartialEq for PantryItem

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PantryItem