static_files/mods/
resource_dir.rs

1use super::sets::{generate_resources_sets, SplitByCount};
2use std::{
3    env, io,
4    path::{Path, PathBuf},
5};
6
7/// Generate resources for `resource_dir`.
8///
9/// ```rust
10/// // Generate resources for ./tests dir with file name generated.rs
11/// // stored in path defined by OUT_DIR environment variable.
12/// // Function name is 'generate'
13/// use static_files::resource_dir;
14///
15/// resource_dir("./tests").build().unwrap();
16/// ```
17pub fn resource_dir<P: AsRef<Path>>(resource_dir: P) -> ResourceDir {
18    ResourceDir {
19        resource_dir: resource_dir.as_ref().into(),
20        ..Default::default()
21    }
22}
23
24/// Resource dir.
25///
26/// A builder structure allows to change default settings for:
27/// - file filter
28/// - generated file name
29/// - generated function name
30#[derive(Default)]
31pub struct ResourceDir {
32    pub(crate) resource_dir: PathBuf,
33    pub(crate) filter: Option<fn(p: &Path) -> bool>,
34    pub(crate) generated_filename: Option<PathBuf>,
35    pub(crate) generated_fn: Option<String>,
36    pub(crate) module_name: Option<String>,
37    pub(crate) count_per_module: Option<usize>,
38}
39
40pub const DEFAULT_MODULE_NAME: &str = "sets";
41pub const DEFAULT_COUNT_PER_MODULE: usize = 256;
42
43impl ResourceDir {
44    /// Generates resources for current configuration.
45    pub fn build(self) -> io::Result<()> {
46        let generated_filename = self.generated_filename.unwrap_or_else(|| {
47            let out_dir = env::var("OUT_DIR").unwrap();
48
49            Path::new(&out_dir).join("generated.rs")
50        });
51        let generated_fn = self.generated_fn.unwrap_or_else(|| "generate".into());
52
53        let module_name = self
54            .module_name
55            .unwrap_or_else(|| format!("{}_{}", &generated_fn, DEFAULT_MODULE_NAME));
56
57        let count_per_module = self.count_per_module.unwrap_or(DEFAULT_COUNT_PER_MODULE);
58
59        generate_resources_sets(
60            &self.resource_dir,
61            self.filter,
62            &generated_filename,
63            module_name.as_str(),
64            &generated_fn,
65            &mut SplitByCount::new(count_per_module),
66        )
67    }
68
69    /// Sets the file filter.
70    pub fn with_filter(&mut self, filter: fn(p: &Path) -> bool) -> &mut Self {
71        self.filter = Some(filter);
72        self
73    }
74
75    /// Sets the generated filename.
76    pub fn with_generated_filename<P: AsRef<Path>>(&mut self, generated_filename: P) -> &mut Self {
77        self.generated_filename = Some(generated_filename.as_ref().into());
78        self
79    }
80
81    /// Sets the generated function name.
82    pub fn with_generated_fn<S>(&mut self, generated_fn: S) -> &mut Self
83    where
84        S: Into<String>,
85    {
86        self.generated_fn = Some(generated_fn.into());
87        self
88    }
89
90    /// Sets the generated module name.
91    ///
92    /// Default value is based on generated function name and the suffix "sets".
93    /// Generated module would be overriden by each call.
94    pub fn with_module_name<S>(&mut self, module_name: S) -> &mut Self
95    where
96        S: Into<String>,
97    {
98        self.module_name = Some(module_name.into());
99        self
100    }
101
102    /// Sets maximal count of files per module.
103    pub fn with_count_per_module(&mut self, count_per_module: usize) -> &mut Self {
104        self.count_per_module = Some(count_per_module);
105        self
106    }
107}
static_files/mods/resource_dir.rs

static_files/mods/
resource_dir.rs
