loco 0.16.3

Loco new app generator
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

//! This module defines error handling and the [`Executer`] trait

use crate::settings::Settings;
mod filesystem;
mod inmem;
use std::path::{Path, PathBuf};

pub use filesystem::FileSystem;
pub use inmem::Inmem;
#[cfg(test)]
use mockall::{automock, predicate::*};

pub type Result<T> = std::result::Result<T, Error>;

#[derive(thiserror::Error, Debug)]
pub enum Error {
    #[error("{0}")]
    Message(String),

    #[error(transparent)]
    TemplateEngine(#[from] Box<rhai::EvalAltResult>),

    #[error(transparent)]
    FS(#[from] fs_extra::error::Error),

    #[error(transparent)]
    Template(#[from] tera::Error),
}
impl Error {
    /// Creates a new error with a custom message.
    pub fn msg<S: Into<String>>(msg: S) -> Self {
        Self::Message(msg.into())
    }
}

#[cfg_attr(test, automock)]
pub trait Executer: Send + Sync {
    /// Copies a single file from the specified path.
    ///
    /// # Errors
    ///
    /// Returns an error if the file cannot be copied, such as if the path is
    /// invalid or if a file system error occurs.
    fn copy_file(&self, path: &Path) -> Result<PathBuf>;

    /// Copies a single file from the specified path.
    ///
    /// # Errors
    ///
    /// Returns an error if the file cannot be copied, such as if the path is
    /// invalid or if a file system error occurs.
    fn create_file(&self, path: &Path, content: String) -> Result<PathBuf>;

    /// Copies an entire directory from the specified path.
    ///
    /// # Errors
    ///
    /// Returns an error if the directory cannot be copied, such as if the path
    /// is invalid or if a file system error occurs.
    fn copy_dir(&self, path: &Path) -> Result<()>;

    /// Copies a template file from the specified path, applying settings.
    ///
    /// # Errors
    ///
    /// Returns an error if the template cannot be copied or if any
    /// settings-related error occurs.
    fn copy_template(&self, path: &Path, data: &Settings) -> Result<()>;

    /// Copies an entire template directory from the specified path, applying
    /// settings.
    ///
    /// # Errors
    ///
    /// Returns an error if the template directory cannot be copied or if any
    /// settings-related error occurs.
    fn copy_template_dir(&self, path: &Path, data: &Settings) -> Result<()>;
}