sous 0.3.0

Manage culinary recipes in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

//! Types for representing ingredients.

use std::fmt;
use std::fmt::Write;

use serde::{Deserialize, Serialize};

/// An ingredient used in a culinary recipe.
#[derive(Clone, Debug, PartialEq, PartialOrd, Default, Serialize, Deserialize)]
pub struct Ingredient {
    /// The ingredient's display name.
    pub name: String,
    /// Optional amount of the ingredient to be used.
    pub amount: Option<f32>,
    /// Optional unit description.
    pub unit: Option<String>,
}

impl Ingredient {
    /// Create a new, empty ingredient.
    pub fn new() -> Self {
        Default::default()
    }

    /// Generate a human-readable [String] representation of the ingredient.
    pub fn to_string(&self) -> String {
        let mut ret = String::new();

        if let Some(amount) = &self.amount {
            write!(ret, "{} ", amount).unwrap();
        }

        if let Some(unit) = &self.unit {
            write!(ret, "{} ", unit).unwrap();
        }

        write!(ret, "{}", self.name).unwrap();
        ret
    }
}

impl fmt::Display for Ingredient {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.to_string())
    }
}