rust_embed_utils/
lib.rs

Help
1#![forbid(unsafe_code)]
2
3use sha2::Digest;
4use std::borrow::Cow;
5use std::path::Path;
6use std::time::SystemTime;
7use std::{fs, io};
8
9#[cfg_attr(all(debug_assertions, not(feature = "debug-embed")), allow(unused))]
10pub struct FileEntry {
11  pub rel_path: String,
12  pub full_canonical_path: String,
13}
14
15#[cfg(not(feature = "include-exclude"))]
16pub fn is_path_included(_path: &str, _includes: &[&str], _excludes: &[&str]) -> bool {
17  true
18}
19
20#[cfg(feature = "include-exclude")]
21pub fn is_path_included(rel_path: &str, includes: &[&str], excludes: &[&str]) -> bool {
22  use globset::Glob;
23
24  // ignore path matched by exclusion pattern
25  for exclude in excludes {
26    let pattern = Glob::new(exclude)
27      .unwrap_or_else(|_| panic!("invalid exclude pattern '{}'", exclude))
28      .compile_matcher();
29
30    if pattern.is_match(rel_path) {
31      return false;
32    }
33  }
34
35  // accept path if no includes provided
36  if includes.is_empty() {
37    return true;
38  }
39
40  // accept path if matched by inclusion pattern
41  for include in includes {
42    let pattern = Glob::new(include)
43      .unwrap_or_else(|_| panic!("invalid include pattern '{}'", include))
44      .compile_matcher();
45
46    if pattern.is_match(rel_path) {
47      return true;
48    }
49  }
50
51  false
52}
53
54#[cfg_attr(all(debug_assertions, not(feature = "debug-embed")), allow(unused))]
55pub fn get_files<'patterns>(folder_path: String, includes: &'patterns [&str], excludes: &'patterns [&str]) -> impl Iterator<Item = FileEntry> + 'patterns {
56  walkdir::WalkDir::new(&folder_path)
57    .follow_links(true)
58    .sort_by_file_name()
59    .into_iter()
60    .filter_map(|e| e.ok())
61    .filter(|e| e.file_type().is_file())
62    .filter_map(move |e| {
63      let rel_path = path_to_str(e.path().strip_prefix(&folder_path).unwrap());
64      let full_canonical_path = path_to_str(std::fs::canonicalize(e.path()).expect("Could not get canonical path"));
65
66      let rel_path = if std::path::MAIN_SEPARATOR == '\\' {
67        rel_path.replace('\\', "/")
68      } else {
69        rel_path
70      };
71
72      if is_path_included(&rel_path, includes, excludes) {
73        Some(FileEntry { rel_path, full_canonical_path })
74      } else {
75        None
76      }
77    })
78}
79
80/// A file embedded into the binary
81pub struct EmbeddedFile {
82  pub data: Cow<'static, [u8]>,
83  pub metadata: Metadata,
84}
85
86/// Metadata about an embedded file
87pub struct Metadata {
88  hash: [u8; 32],
89  last_modified: Option<u64>,
90  #[cfg(feature = "mime-guess")]
91  mimetype: Cow<'static, str>,
92}
93
94impl Metadata {
95  #[doc(hidden)]
96  pub fn __rust_embed_new(hash: [u8; 32], last_modified: Option<u64>, #[cfg(feature = "mime-guess")] mimetype: &'static str) -> Self {
97    Self {
98      hash,
99      last_modified,
100      #[cfg(feature = "mime-guess")]
101      mimetype: mimetype.into(),
102    }
103  }
104
105  /// The SHA256 hash of the file
106  pub fn sha256_hash(&self) -> [u8; 32] {
107    self.hash
108  }
109
110  /// The last modified date in seconds since the UNIX epoch. If the underlying
111  /// platform/file-system does not support this, None is returned.
112  pub fn last_modified(&self) -> Option<u64> {
113    self.last_modified
114  }
115
116  /// The mime type of the file
117  #[cfg(feature = "mime-guess")]
118  pub fn mimetype(&self) -> &str {
119    &self.mimetype
120  }
121}
122
123pub fn read_file_from_fs(file_path: &Path) -> io::Result<EmbeddedFile> {
124  let data = fs::read(file_path)?;
125  let data = Cow::from(data);
126
127  let mut hasher = sha2::Sha256::new();
128  hasher.update(&data);
129  let hash: [u8; 32] = hasher.finalize().into();
130
131  let source_date_epoch = match std::env::var("SOURCE_DATE_EPOCH") {
132    Ok(value) => value.parse::<u64>().map_or(None, |v| Some(v)),
133    Err(_) => None,
134  };
135
136  let last_modified = fs::metadata(file_path)?.modified().ok().map(|last_modified| {
137    last_modified
138      .duration_since(SystemTime::UNIX_EPOCH)
139      .expect("Time before the UNIX epoch is unsupported")
140      .as_secs()
141  });
142
143  #[cfg(feature = "mime-guess")]
144  let mimetype = mime_guess::from_path(file_path).first_or_octet_stream().to_string();
145
146  Ok(EmbeddedFile {
147    data,
148    metadata: Metadata {
149      hash,
150      last_modified: source_date_epoch.or(last_modified),
151      #[cfg(feature = "mime-guess")]
152      mimetype: mimetype.into(),
153    },
154  })
155}
156
157fn path_to_str<P: AsRef<std::path::Path>>(p: P) -> String {
158  p.as_ref().to_str().expect("Path does not have a string representation").to_owned()
159}
rust_embed_utils/lib.rs

rust_embed_utils/
lib.rs
