rust-embed

git clone https://pyrossh.dev/repos/rust-embed.git
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.

34dabb93 — Peter

Merge pull request #47 from vemoo/cow-opt

Files changed (7) hide show

Cargo.toml +2 -2
changelog.md +12 -0
examples/actix.rs +8 -3
examples/rocket.rs +10 -4
impl/Cargo.toml +1 -1
impl/src/lib.rs +14 -11
readme.md +5 -5

Cargo.toml CHANGED Viewed

@@ -1,6 +1,6 @@
 [package]
 name = "rust-embed"
-version = "4.1.0"
+version = "4.2.0"
 description = "Rust Custom Derive Macro which loads files into the rust binary at compile time during release and loads the file from the fs during dev"
 readme = "readme.md"
 documentation = "https://docs.rs/rust-embed"
@@ -12,7 +12,7 @@ authors = ["pyros2097 <pyros2097@gmail.com>"]
 [dependencies]
 walkdir = "2.1.4"
-rust-embed-impl = { version = "4.1.0", path = "impl"}
+rust-embed-impl = { version = "4.2.0", path = "impl"}
 actix-web = { version = "0.7", optional = true }
 mime_guess = { version = "2.0.0-alpha.6", optional = true }

changelog.md CHANGED Viewed

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 Thanks to [Mcat12](https://github.com/Mcat12) for the changelog.
+## [4.2.0] - 2018-12-02
+### Changed
+- return `Cow<'static, [u8]>` to preserve static lifetime
+## [4.1.0] - 2018-10-24
+### Added
+- `iter()` method to list files
+## [4.0.0] - 2018-10-11
+### Changed
+- avoid vector allocation by returning `impl AsRef<[u8]>`
 ## [3.0.2] - 2018-09-05
 ### Added
 - appveyor for testing on windows

examples/actix.rs CHANGED Viewed

@@ -6,6 +6,7 @@ extern crate mime_guess;
 use actix_web::http::Method;
 use actix_web::{server, App, Body, HttpRequest, HttpResponse};
 use mime_guess::guess_mime_type;
+use std::borrow::Cow;
 #[derive(RustEmbed)]
 #[folder = "examples/public/"]
@@ -13,9 +14,13 @@ struct Asset;
 fn handle_embedded_file(path: &str) -> HttpResponse {
   match Asset::get(path) {
-    Some(content) => HttpResponse::Ok()
+    Some(content) => {
+      let body: Body = match content {
+        Cow::Borrowed(bytes) => bytes.into(),
+        Cow::Owned(bytes) => bytes.into(),
+      };
-      .content_type(guess_mime_type(path).as_ref())
+      HttpResponse::Ok().content_type(guess_mime_type(path).as_ref()).body(body)
-      .body(Body::from_slice(content.as_ref())),
+    }
     None => HttpResponse::NotFound().body("404 Not Found"),
   }
 }

examples/rocket.rs CHANGED Viewed

@@ -26,11 +26,17 @@ fn index<'r>() -> response::Result<'r> {
 #[get("/dist/<file..>")]
 fn dist<'r>(file: PathBuf) -> response::Result<'r> {
   let filename = file.display().to_string();
-  let ext = file.as_path().extension().and_then(OsStr::to_str).expect("Could not get file extension");
-  let content_type = ContentType::from_extension(ext).expect("Could not get file content type");
-  Asset::get(&filename.clone()).map_or_else(
+  Asset::get(&filename).map_or_else(
     || Err(Status::NotFound),
+    |d| {
+      let ext = file
+        .as_path()
+        .extension()
+        .and_then(OsStr::to_str)
+        .ok_or(Status::new(400, "Could not get file extension"))?;
+      let content_type = ContentType::from_extension(ext).ok_or(Status::new(400, "Could not get file content type"))?;
-    |d| response::Response::build().header(content_type).sized_body(Cursor::new(d)).ok(),
+      response::Response::build().header(content_type).sized_body(Cursor::new(d)).ok()
+    },
   )
 }

impl/Cargo.toml CHANGED Viewed

@@ -1,6 +1,6 @@
 [package]
 name = "rust-embed-impl"
-version = "4.1.0"
+version = "4.2.0"
 description = "Rust Custom Derive Macro which loads files into the rust binary at compile time during release and loads the file from the fs during dev"
 readme = "readme.md"
 documentation = "https://docs.rs/rust-embed"

impl/src/lib.rs CHANGED Viewed

@@ -15,9 +15,9 @@ mod utils;
 #[cfg(all(debug_assertions, not(feature = "debug-embed")))]
 fn generate_assets(ident: &syn::Ident, folder_path: String) -> quote::Tokens {
-  quote!{
+  quote! {
       impl #ident {
-          pub fn get(file_path: &str) -> Option<impl AsRef<[u8]>> {
+          pub fn get(file_path: &str) -> Option<std::borrow::Cow<'static, [u8]>> {
               use std::fs::File;
               use std::io::Read;
               use std::path::Path;
@@ -31,17 +31,17 @@ fn generate_assets(ident: &syn::Ident, folder_path: String) -> quote::Tokens {
               };
               let mut data: Vec<u8> = Vec::new();
               match file.read_to_end(&mut data) {
-                  Ok(_) => Some(data),
+                  Ok(_) => Some(std::borrow::Cow::from(data)),
                   Err(_e) =>  {
                       return None
                   }
               }
           }
-          pub fn iter() -> impl Iterator<Item = impl AsRef<str>> {
+          pub fn iter() -> impl Iterator<Item = std::borrow::Cow<'static, str>> {
               use std::path::Path;
               use rust_embed::utils::get_files;
-              get_files(String::from(#folder_path)).map(|e| e.rel_path)
+              get_files(String::from(#folder_path)).map(|e| std::borrow::Cow::from(e.rel_path))
           }
       }
   }
@@ -55,26 +55,29 @@ fn generate_assets(ident: &syn::Ident, folder_path: String) -> quote::Tokens {
   let mut list_values = Vec::<String>::new();
   for FileEntry { rel_path, full_canonical_path } in get_files(folder_path) {
-    match_values.push(quote!{
+    match_values.push(quote! {
+      #rel_path => {
-      #rel_path => Some(&include_bytes!(#full_canonical_path)[..]),
+          let bytes = &include_bytes!(#full_canonical_path)[..];
+          Some(std::borrow::Cow::from(bytes))
+      },
     });
     list_values.push(rel_path);
   }
   let array_len = list_values.len();
-  quote!{
+  quote! {
       impl #ident {
-          pub fn get(file_path: &str) -> Option<impl AsRef<[u8]>> {
+          pub fn get(file_path: &str) -> Option<std::borrow::Cow<'static, [u8]>> {
               match file_path {
                   #(#match_values)*
                   _ => None,
               }
           }
-          pub fn iter() -> impl Iterator<Item = impl AsRef<str>> {
+          pub fn iter() -> impl Iterator<Item = std::borrow::Cow<'static, str>> {
               static items: [&str; #array_len] = [#(#list_values),*];
-              items.iter()
+              items.iter().map(|x| std::borrow::Cow::from(*x))
           }
       }
   }

readme.md CHANGED Viewed

@@ -13,7 +13,7 @@ You can use this to embed your css, js and images into a single executable which
 ```toml
 [dependencies]
-rust-embed="4.1.0"
+rust-embed="4.2.0"
 ```
 ## Documentation
@@ -36,11 +36,11 @@ The macro will generate the following code:
 ```rust
 impl Asset {
-  pub fn get(file_path: &str) -> Option<impl AsRef<[u8]>> {
+  pub fn get(file_path: &str) -> Option<Cow<'static, [u8]>> {
     ...
   }
-  pub fn iter() -> impl Iterator<Item = impl AsRef<str>> {
+  pub fn iter() -> impl Iterator<Item = Cow<'static, str>> {
     ...
   }
 }
@@ -50,9 +50,9 @@ impl Asset {
 Given a relative path from the assets folder returns the bytes if found.
-If the feature `debug-embed` is enabled or the binary  compiled in release mode the bytes have been embeded in the binary and a `&'static [u8]` is returned.
+If the feature `debug-embed` is enabled or the binary  compiled in release mode the bytes have been embeded in the binary and a `Cow::Borrowed(&'static [u8])` is returned.
-Otherwise the bytes are read from the file system on each call and a `Vec<u8>` is returned.
+Otherwise the bytes are read from the file system on each call and a `Cow::Owned(Vec<u8>)` is returned.
 ### `iter()`

~repos /rust-embed

git clone https://pyrossh.dev/repos/rust-embed.git 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 clone https://pyrossh.dev/repos/rust-embed.git
Discussions: https://groups.google.com/g/rust-embed-devs