reget 0.2.1

A simple recipe parser for html and json-ld with optional markdown support
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

/// A recipe extracted from HTML using [parse_recipe](crate::parse_recipe).
#[derive(Default, Debug, Clone, PartialEq, Eq)]
pub struct Recipe {
    /// The name of the recipe.
    pub name: Option<String>,
    /// The author of the recipe.
    ///
    /// If the recipe specifies multiple authors, they will be joined into a single string
    /// (e.g. "Author One, Author Two")
    pub author: Option<String>,
    /// The description of the recipe.
    pub description: Option<String>,
    /// A list of ingredients used by the recipe.
    pub ingredients: Vec<Ingredient>,
    /// A list of [how-to-sections](HowToSection) for the recipe.
    ///
    /// If the recipe does not use [how-to-sections](HowToSection) this will contain
    /// a single section without a name.
    pub how_to_sections: Vec<HowToSection>,
}

/// A collection of [how-to-steps](HowToStep) with an optional name
#[derive(Default, Debug, Clone, PartialEq, Eq)]
pub struct HowToSection {
    /// The name of the section, if available.
    pub name: Option<String>,
    /// A list of steps in the section.
    pub steps: Vec<HowToStep>,
}

/// A single ingredient used in a recipe
pub type Ingredient = String;

/// A single how-to-step of a recipe
pub type HowToStep = String;

impl Recipe {
    #[cfg(feature = "markdown")]
    /// Constructs a [MarkdownBuilder](crate::MarkdownBuilder) to convert this
    /// recipe to markdown format
    pub fn to_markdown(&self) -> crate::MarkdownBuilder {
        crate::MarkdownBuilder::from(self)
    }
}