recipemd 0.2.0

Parser for the RecipeMD format
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

// Copyright (c) 2023 d-k-bo
// SPDX-License-Identifier: LGPL-3.0-or-later

//! A library for parsing recipes written in markdown that follows the
//! [RecipeMD](https://recipemd.org/) specification.
//!
//! # Example
//!
//! ```
//! # use recipemd::{Recipe, Result};
//! const MARKDOWN: &str = r#"# Water
//!
//! A refreshing drink that should be consumed several times a day.
//!
//! *drink, non-alcoholic, H2O*
//!
//! **1 glass**
//!
//! ---
//!
//! - *1* glass
//! - *1* faucet
//!
//! ---
//!
//! Turn on the faucet and fill the glass.
//! "#;
//!
//! # fn main() -> Result<()> {
//! let recipe = Recipe::parse(MARKDOWN)?;
//! println!("{recipe:#?}");
//! # Ok(()) }
//! ```
//! <details><summary>Result of the above program</summary>
//!
//!
//! ```ignore
#![doc = include_str!("../examples/water.txt")]
//! ```
//!
//! (If it doesn't show up, visit the [docs](https://docs.rs/recipemd#example) instead)
//!
//! </details>

#![cfg_attr(docsrs, feature(doc_auto_cfg))]

mod ast;
mod error;
mod models;
mod parser;
mod utils;

use std::str::FromStr;

#[doc(inline)]
pub use error::*;
#[doc(inline)]
pub use models::*;
use parser::RecipeParser;

impl Recipe {
    /// Parse a recipe from a markdown string.
    #[cfg(feature = "diagnostics")]
    pub fn parse(src: &str) -> Result<Self> {
        RecipeParser::new(src)
            .parse_recipe()
            .map_err(|e| e.with_src(src.to_owned()))
    }
    #[cfg(not(feature = "diagnostics"))]
    pub fn parse(src: &str) -> Result<Self> {
        RecipeParser::new(src).parse_recipe()
    }
}

impl FromStr for Recipe {
    type Err = Error;

    fn from_str(src: &str) -> Result<Self> {
        Recipe::parse(src)
    }
}