include_folder_shared 0.3.0

Shared code for include_folder and include_folder_macros.
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
82
83
84

pub use globbing::*;
use std::fmt::Debug;
mod globbing;

#[derive(Debug, Clone)]
pub struct File {
    pub path: String,
    pub data: FileData,
}

#[derive(Debug, Clone)]
pub enum FileData {
    Blob(Vec<u8>),
    Text(String),
}

impl FileData {
    pub fn _type(&self) -> String {
        match self {
            Self::Blob(_) => "Vec<u8>",
            Self::Text(_) => "String",
        }
        .to_string()
    }
}

/// All generated structs implement this.
pub trait Directory {
    /// Gives you all the files in a directory or other such struct recursively.
    ///
    /// The paths returned from this will use periods as seperators as it looks when you are
    /// accessing the files as fields on a struct.
    ///
    /// A generated implementation may look like this:
    ///
    /// ```
    /// impl ::include_folder::Directory for TestDirSrc {
    ///     fn files(&self) -> Vec<::include_folder::File> {
    ///         use ::include_folder::Data;
    ///         <[_]>::into_vec(
    ///             #[rustc_box]
    ///             ::alloc::boxed::Box::new([
    ///                 ::include_folder::File {
    ///                     path: "nested.folders.test.txt".to_string(),
    ///                     data: self.nested.folders.test.txt.clone().to_file_data(),
    ///                 },
    ///                 ::include_folder::File {
    ///                     path: "parsing.lexer.txt".to_string(),
    ///                     data: self.parsing.lexer.txt.clone().to_file_data(),
    ///                 },
    ///                 ::include_folder::File {
    ///                     path: "parsing.lexer.rs".to_string(),
    ///                     data: self.parsing.lexer.rs.clone().to_file_data(),
    ///                 },
    ///                 ::include_folder::File {
    ///                     path: "main.rs".to_string(),
    ///                     data: self.main.rs.clone().to_file_data(),
    ///                 },
    ///             ]),
    ///         )
    ///     }
    /// }
    /// ```
    fn files(&self) -> Vec<File>;
    fn glob(&self, search: &str) -> Result<Vec<File>, globset::Error> {
        glob(self.files(), search)
    }
}

pub trait Data {
    fn to_file_data(self) -> FileData;
}

impl Data for String {
    fn to_file_data(self) -> FileData {
        FileData::Text(self)
    }
}

impl Data for Vec<u8> {
    fn to_file_data(self) -> FileData {
        FileData::Blob(self)
    }
}