rust-embed

GIT_CONFIG_PARAMETERS="'http.version=HTTP/1.1'" git clone https://git.pyrossh.dev/rust-embed/.git rust-embed
Discussions: https://groups.google.com/g/rust-embed-devs

rust macro which loads files into the rust binary at compile time during release and loads the file from the fs during dev.

8e80155b — Tommy Yu

Make Way to avoid compile failure on undefined env

Files changed (2) hide show

impl/src/lib.rs +87 -57
tests/interpolated_path.rs +20 -0

impl/src/lib.rs CHANGED Viewed

@@ -17,7 +17,7 @@ use std::{
 use syn::{parse_macro_input, Data, DeriveInput, Expr, ExprLit, Fields, Lit, Meta, MetaNameValue};
 fn embedded(
-  ident: &syn::Ident, relative_folder_path: Option<&str>, absolute_folder_path: String, prefix: Option<&str>, includes: &[String], excludes: &[String],
+  ident: &syn::Ident, relative_folder_path: Option<&str>, absolute_folder_path: Option<String>, prefix: Option<&str>, includes: &[String], excludes: &[String],
   metadata_only: bool, crate_path: &syn::Path,
 ) -> syn::Result<TokenStream2> {
   extern crate rust_embed_utils;
@@ -28,7 +28,11 @@ fn embedded(
   let includes: Vec<&str> = includes.iter().map(AsRef::as_ref).collect();
   let excludes: Vec<&str> = excludes.iter().map(AsRef::as_ref).collect();
   let matcher = PathMatcher::new(&includes, &excludes);
+  let entries = absolute_folder_path.clone()
+    .map(|v| rust_embed_utils::get_files(v, matcher))
+    .into_iter()
+    .flatten();
-  for rust_embed_utils::FileEntry { rel_path, full_canonical_path } in rust_embed_utils::get_files(absolute_folder_path.clone(), matcher) {
+  for rust_embed_utils::FileEntry { rel_path, full_canonical_path } in entries {
     match_values.insert(
       rel_path.clone(),
       embed_file(relative_folder_path, ident, &rel_path, &full_canonical_path, metadata_only, crate_path)?,
@@ -111,7 +115,7 @@ fn embedded(
 }
 fn dynamic(
-  ident: &syn::Ident, folder_path: String, prefix: Option<&str>, includes: &[String], excludes: &[String], metadata_only: bool, crate_path: &syn::Path,
+  ident: &syn::Ident, folder_path: Option<String>, prefix: Option<&str>, includes: &[String], excludes: &[String], metadata_only: bool, crate_path: &syn::Path,
 ) -> TokenStream2 {
   let (handle_prefix, map_iter) = if let ::std::option::Option::Some(prefix) = prefix {
     (
@@ -136,27 +140,17 @@ fn dynamic(
       .map(|mut file| { file.data = ::std::default::Default::default(); file })
   });
+  let methods = if let Some(ref folder_path) = folder_path {
-  let non_canonical_folder_path = Path::new(&folder_path);
+    let non_canonical_folder_path = Path::new(&folder_path);
-  let canonical_folder_path = non_canonical_folder_path
+    let canonical_folder_path = non_canonical_folder_path
-    .canonicalize()
+      .canonicalize()
-    .or_else(|err| match err {
+      .or_else(|err| match err {
-      err if err.kind() == ErrorKind::NotFound => Ok(non_canonical_folder_path.to_owned()),
+        err if err.kind() == ErrorKind::NotFound => Ok(non_canonical_folder_path.to_owned()),
-      err => Err(err),
+        err => Err(err),
-    })
+      })
-    .expect("folder path must resolve to an absolute path");
+      .expect("folder path must resolve to an absolute path");
-  let canonical_folder_path = canonical_folder_path.to_str().expect("absolute folder path must be valid unicode");
+    let canonical_folder_path = canonical_folder_path.to_str().expect("absolute folder path must be valid unicode");
-  quote! {
+    quote! {
-      #[cfg(debug_assertions)]
-      impl #ident {
-        fn matcher() -> #crate_path::utils::PathMatcher {
-            #declare_includes
-            #declare_excludes
-            static PATH_MATCHER: ::std::sync::OnceLock<#crate_path::utils::PathMatcher> = ::std::sync::OnceLock::new();
-            PATH_MATCHER.get_or_init(|| #crate_path::utils::PathMatcher::new(INCLUDES, EXCLUDES)).clone()
-        }
           /// Get an embedded file and its metadata.
           pub fn get(file_path: &str) -> ::std::option::Option<#crate_path::EmbeddedFile> {
               #handle_prefix
@@ -191,10 +185,38 @@ fn dynamic(
           pub fn iter() -> impl ::std::iter::Iterator<Item = ::std::borrow::Cow<'static, str>> + 'static {
               use ::std::path::Path;
               #crate_path::utils::get_files(::std::string::String::from(#folder_path), Self::matcher())
                   .map(|e| #map_iter)
           }
+    }
+  } else {
+    quote! {
+          /// Get an embedded file and its metadata.
+          pub fn get(file_path: &str) -> ::std::option::Option<#crate_path::EmbeddedFile> {
+              // No folder_path defined so nothing can be returned.
+              None
+          }
+          /// Iterates over the file paths in the folder.
+          pub fn iter() -> impl ::std::iter::Iterator<Item = ::std::borrow::Cow<'static, str>> + 'static {
+              None.into_iter()
+          }
+    }
+  };
+  quote! {
+      #[cfg(debug_assertions)]
+      impl #ident {
+        fn matcher() -> #crate_path::utils::PathMatcher {
+            #declare_includes
+            #declare_excludes
+            static PATH_MATCHER: ::std::sync::OnceLock<#crate_path::utils::PathMatcher> = ::std::sync::OnceLock::new();
+            PATH_MATCHER.get_or_init(|| #crate_path::utils::PathMatcher::new(INCLUDES, EXCLUDES)).clone()
+        }
+          #methods
       }
       #[cfg(debug_assertions)]
@@ -211,7 +233,7 @@ fn dynamic(
 }
 fn generate_assets(
-  ident: &syn::Ident, relative_folder_path: Option<&str>, absolute_folder_path: String, prefix: Option<String>, includes: Vec<String>, excludes: Vec<String>,
+  ident: &syn::Ident, relative_folder_path: Option<&str>, absolute_folder_path: Option<String>, prefix: Option<String>, includes: Vec<String>, excludes: Vec<String>,
   metadata_only: bool, crate_path: &syn::Path,
 ) -> syn::Result<TokenStream2> {
   let embedded_impl = embedded(
@@ -346,7 +368,7 @@ fn impl_rust_embed(ast: &syn::DeriveInput) -> syn::Result<TokenStream2> {
       "#[derive(RustEmbed)] must contain one attribute like this #[folder = \"examples/public/\"]",
     ));
   }
-  let folder_path = folder_paths.remove(0);
+  let folder_path = Some(folder_paths.remove(0));
   let prefix = find_attribute_values(ast, "prefix").into_iter().next();
   let includes = find_attribute_values(ast, "include");
@@ -362,41 +384,49 @@ fn impl_rust_embed(ast: &syn::DeriveInput) -> syn::Result<TokenStream2> {
     ));
   }
+    // .map_err(|v| syn::Error::new_spanned(ast, v.to_string()))?
   #[cfg(feature = "interpolate-folder-path")]
-  let folder_path = shellexpand::full(&folder_path)
+  let folder_path = match shellexpand::full(&folder_path.unwrap()) {
+    Ok(v) => Ok(Some(v.to_string())),
+    Err(v) if v.cause == std::env::VarError::NotPresent && allow_missing => Ok(None),
-    .map_err(|v| syn::Error::new_spanned(ast, v.to_string()))?
+    Err(v) => Err(syn::Error::new_spanned(ast, v.to_string())),
-    .to_string();
+  }?;
   // Base relative paths on the Cargo.toml location
+  let (relative_path, absolute_folder_path) = if let Some(folder_path) = folder_path {
-  let (relative_path, absolute_folder_path) = if Path::new(&folder_path).is_relative() {
+    let (relative_path, absolute_folder_path) = if Path::new(&folder_path).is_relative() {
-    let absolute_path = Path::new(&env::var("CARGO_MANIFEST_DIR").unwrap())
+      let absolute_path = Path::new(&env::var("CARGO_MANIFEST_DIR").unwrap())
-      .join(&folder_path)
+        .join(&folder_path)
-      .to_str()
+        .to_str()
-      .unwrap()
+        .unwrap()
-      .to_owned();
+        .to_owned();
-    (Some(folder_path.clone()), absolute_path)
+      (Some(folder_path.clone()), absolute_path)
-  } else {
+    } else {
-    if cfg!(feature = "compression") {
+      if cfg!(feature = "compression") {
-      return Err(syn::Error::new_spanned(ast, "`folder` must be a relative path under `compression` feature."));
+        return Err(syn::Error::new_spanned(ast, "`folder` must be a relative path under `compression` feature."));
-    }
+      }
-    (None, folder_path)
+      (None, folder_path)
-  };
+    };
-  if !Path::new(&absolute_folder_path).exists() && !allow_missing {
-    let mut message = format!(
-      "#[derive(RustEmbed)] folder '{}' does not exist. cwd: '{}'",
-      absolute_folder_path,
-      std::env::current_dir().unwrap().to_str().unwrap()
-    );
+    if !Path::new(&absolute_folder_path).exists() && !allow_missing {
+      let mut message = format!(
+        "#[derive(RustEmbed)] folder '{}' does not exist. cwd: '{}'",
+        absolute_folder_path,
+        std::env::current_dir().unwrap().to_str().unwrap()
+      );
-    // Add a message about the interpolate-folder-path feature if the path may
+      // Add a message about the interpolate-folder-path feature if the path may
-    // include a variable
+      // include a variable
-    if absolute_folder_path.contains('$') && cfg!(not(feature = "interpolate-folder-path")) {
+      if absolute_folder_path.contains('$') && cfg!(not(feature = "interpolate-folder-path")) {
-      message += "\nA variable has been detected. RustEmbed can expand variables \
+        message += "\nA variable has been detected. RustEmbed can expand variables \
-                  when the `interpolate-folder-path` feature is enabled.";
+                    when the `interpolate-folder-path` feature is enabled.";
-    }
+      }
-    return Err(syn::Error::new_spanned(ast, message));
+      return Err(syn::Error::new_spanned(ast, message));
+    };
+    (relative_path, Some(absolute_folder_path))
+  } else {
+    (None, None)
   };
   generate_assets(

tests/interpolated_path.rs CHANGED Viewed

@@ -5,6 +5,26 @@ use rust_embed::Embed;
 #[folder = "$CARGO_MANIFEST_DIR/examples/public/"]
 struct Asset;
+static CHECK_UNDEFINED: Option<&str> = option_env!("__UNDEFINED__");
+#[derive(Embed)]
+#[folder = "$__UNDEFINED__/examples/public/"]
+#[allow_missing = true]
+struct UndefinedAsset;
+#[test]
+fn undefined_usable() {
+  assert!(CHECK_UNDEFINED.is_none(), "__UNDEFINED__ should not be defined at compile time");
+  assert!(UndefinedAsset::get("index.html").is_none(), "index.html should not exist");
+  let mut num_files = 0;
+  for file in UndefinedAsset::iter() {
+    assert!(UndefinedAsset::get(file.as_ref()).is_some());
+    num_files += 1;
+  }
+  assert_eq!(num_files, 0);
+}
 #[test]
 fn get_works() {
   assert!(Asset::get("index.html").is_some(), "index.html should exist");

~repos /rust-embed

GIT_CONFIG_PARAMETERS="'http.version=HTTP/1.1'" git clone https://git.pyrossh.dev/rust-embed/.git rust-embed Discussions: https://groups.google.com/g/rust-embed-devs

rust macro which loads files into the rust binary at compile time during release and loads the file from the fs during dev.

GIT_CONFIG_PARAMETERS="'http.version=HTTP/1.1'" git clone https://git.pyrossh.dev/rust-embed/.git rust-embed
Discussions: https://groups.google.com/g/rust-embed-devs