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
47
48
49
50

//! Types for managing collections of recipes.

use std::{
    fs::read_dir,
    path::{Path, PathBuf},
};

use crate::{Recipe, SousError};

/// Directory of recipe files.
///
/// Stores both the directory's path on the filesystem and a list of found YAML files.
pub struct Cookbook {
    path: PathBuf,
    recipes: Vec<String>,
}

impl Cookbook {
    /// Open a cookbook directory.
    pub fn open(path: &Path) -> Result<Cookbook, SousError> {
        let dir = read_dir(path)?.filter(|entry| match entry {
            Ok(entry) => match entry.path().extension() {
                Some(extension) => extension == "yml",
                None => false,
            },
            Err(_) => true,
        });

        let mut recipes: Vec<String> = Vec::new();
        for entry in dir {
            recipes.push(match entry?.file_name().into_string() {
                Ok(filename) => filename,
                Err(_) => return Err(SousError::Unknown),
            });
        }
        let path = path.to_path_buf();

        Ok(Cookbook { path, recipes })
    }

    /// Get a borrowed [Vec] of available recipe names.
    pub fn recipes(&self) -> &Vec<String> {
        &self.recipes
    }

    /// Load a [Recipe] matching the given name.
    pub fn load_recipe(&self, name: &str) -> Result<Recipe, SousError> {
        Ok(Recipe::from_file(&self.path.join(name))?)
    }
}