diff --git a/Cargo.lock b/Cargo.lock index 6a8430a..b7168ac 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -6,11 +6,29 @@ version = 4 name = "dir-embed" version = "0.2.0" dependencies = [ + "mime", + "mime_guess", "proc-macro2", "quote", "syn", ] +[[package]] +name = "mime" +version = "0.3.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6877bb514081ee2a7ff5ef9de3281f14a4dd4bceac4c09388074a6b5df8a139a" + +[[package]] +name = "mime_guess" +version = "2.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f7c44f8e672c00fe5308fa235f821cb4198414e1c77935c1ab6948d3fd78550e" +dependencies = [ + "mime", + "unicase", +] + [[package]] name = "proc-macro2" version = "1.0.95" @@ -40,6 +58,12 @@ dependencies = [ "unicode-ident", ] +[[package]] +name = "unicase" +version = "2.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "75b844d17643ee918803943289730bec8aac480150456169e647ed0b576ba539" + [[package]] name = "unicode-ident" version = "1.0.18" diff --git a/Cargo.toml b/Cargo.toml index c7c90f9..778ddb7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,7 +11,12 @@ readme = "README.md" [lib] proc-macro = true +[features] +default = [] + [dependencies] +mime = { version = "0.3.17" } +mime_guess = "2.0.5" proc-macro2 = "1" quote = "1" syn = { version = "2", features = ["full"] } diff --git a/README.md b/README.md index 6f81462..c86ea4a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ Simple way to use [`include_bytes!`](https://doc.rust-lang.org/std/macro.include_bytes.html) for directories. +# Why + +I wanted to include a directory for my microcontroller project, but none of the solutions I used before seems to work in a no_std environment. + # Example -You can embed files two ways. +You can embed files three ways. ## Bytes mode @@ -39,3 +43,25 @@ fn main(){ println!("{file}"); } ``` + +## Mime mode +Same as "Bytes mode" but also add the guessed mime type from [`mime_guess`](https://crates.io/crates/mime_guess). +Defaults to `application/octet-stream` for unknown types. + +```rust +use dir_embed::Embed; + +#[derive(Embed)] +#[dir = "../web/static"] // Path is relativ to the current file +#[mode = "mime"] +pub struct Assets; + +fn main(){ + let file: (&[u8],&str) = Assets::get("css/style.css").expect("Can't find file"); + + let string = str::from_utf8(file.0).expect("Failed to parse file"); + + println!("{string}"); + println!("MIME: {file.1}"); // text/css +} +``` diff --git a/src/lib.rs b/src/lib.rs index 4c15494..ebcd7fe 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,4 @@ +use mime::Mime; use proc_macro::TokenStream; use quote::quote; use syn::spanned::Spanned; @@ -10,6 +11,7 @@ use std::path::{Path, PathBuf}; enum EmbedMode { Bytes, Str, + BytesMime, } #[proc_macro_derive(Embed, attributes(dir, mode))] @@ -44,6 +46,7 @@ pub fn embed(input: proc_macro::TokenStream) -> proc_macro::TokenStream { for entry in collect_files(&absolue_path) { let rel_path = entry + .0 .strip_prefix(&absolue_path) .unwrap() .to_str() @@ -56,29 +59,40 @@ pub fn embed(input: proc_macro::TokenStream) -> proc_macro::TokenStream { let arm = match mode { EmbedMode::Bytes => generate_byte_arm(&rel_path, include_string), EmbedMode::Str => generate_str_arm(&rel_path, include_string), + EmbedMode::BytesMime => generate_mime_arm( + &rel_path, + include_string, + entry.1.unwrap_or(mime::APPLICATION_OCTET_STREAM), + ), }; match_arms.push(arm); } - let expanded = match mode { + #[allow(unused_mut)] + let mut expanded = match mode { EmbedMode::Bytes => generate_byte_impl(struct_name, match_arms), EmbedMode::Str => generate_str_impl(struct_name, match_arms), + EmbedMode::BytesMime => generate_mime_impl(struct_name, match_arms), }; proc_macro::TokenStream::from(expanded) } -fn collect_files(dir: &Path) -> Vec { +fn collect_files(dir: &Path) -> Vec<(PathBuf, Option)> { let mut files = Vec::new(); + for entry in fs::read_dir(dir).unwrap() { let path = entry.unwrap().path(); + if path.is_file() { - files.push(path); + let mime_type = mime_guess::from_path(&path); + files.push((path, mime_type.first())); } else if path.is_dir() { files.extend(collect_files(&path)); } } + files } @@ -102,21 +116,22 @@ fn extract_dir_path(attr: &Attribute) -> String { fn extract_mode(attr: &Attribute) -> EmbedMode { let meta = match &attr.meta { Meta::NameValue(meta) => meta, - _ => panic!("Expected #[mode = \"bytes\"|\"str\"] as a name-value attribute."), + _ => panic!("Expected #[mode = \"bytes\"|\"str\"|\"mime\"] as a name-value attribute."), }; let expr_lit = match &meta.value { Expr::Lit(expr_lit) => expr_lit, - _ => panic!("Expected #[mode = \"bytes\"|\"str\"] with a string literal."), + _ => panic!("Expected #[mode = \"bytes\"|\"str\"|\"mime\"] with a string literal."), }; match &expr_lit.lit { Lit::Str(str) => match str.value().as_str() { "bytes" => EmbedMode::Bytes, "str" => EmbedMode::Str, - other => panic!("Unknown mode: {other}. Use `bytes` or `str`."), + "mime" => EmbedMode::BytesMime, + other => panic!("Unknown mode: {other}. Use `bytes`,`str` or `mime`."), }, - _ => panic!("Expected #[mode = \"bytes\"|\"str\"] to be a string."), + _ => panic!("Expected #[mode = \"bytes\"|\"str\"|\"mime\"] to be a string."), } } @@ -163,3 +178,26 @@ fn generate_str_impl( } } } + +fn generate_mime_arm(rel: &str, include: &str, mime_type: Mime) -> proc_macro2::TokenStream { + let mime_str = mime_type.essence_str(); + quote! { + #rel => Some((include_bytes!(#include),#mime_str)), + } +} + +fn generate_mime_impl( + struct_name: &Ident, + match_arms: Vec, +) -> proc_macro2::TokenStream { + quote! { + impl #struct_name { + pub fn get(name: &str) -> Option<(&'static [u8],&'static str)> { + match name { + #(#match_arms)* + _ => None, + } + } + } + } +} diff --git a/testdata/bytes/bin b/testdata/bytes/bin new file mode 100644 index 0000000..7d174b1 --- /dev/null +++ b/testdata/bytes/bin @@ -0,0 +1 @@ +Þ­¾ï \ No newline at end of file diff --git a/testdata/file1.txt b/testdata/bytes/file1.txt similarity index 100% rename from testdata/file1.txt rename to testdata/bytes/file1.txt diff --git a/testdata/bytes/index.html b/testdata/bytes/index.html new file mode 100644 index 0000000..00e253b --- /dev/null +++ b/testdata/bytes/index.html @@ -0,0 +1,12 @@ + + + +Page Title + + + +

This is a Heading

+

This is a paragraph.

+ + + diff --git a/testdata/sub/file2.txt b/testdata/bytes/sub/file2.txt similarity index 100% rename from testdata/sub/file2.txt rename to testdata/bytes/sub/file2.txt diff --git a/testdata/str/file1.txt b/testdata/str/file1.txt new file mode 100644 index 0000000..08219db --- /dev/null +++ b/testdata/str/file1.txt @@ -0,0 +1 @@ +file1 \ No newline at end of file diff --git a/testdata/str/sub/file2.txt b/testdata/str/sub/file2.txt new file mode 100644 index 0000000..30d67d4 --- /dev/null +++ b/testdata/str/sub/file2.txt @@ -0,0 +1 @@ +file2 \ No newline at end of file diff --git a/tests/byte.rs b/tests/byte.rs index 2aadf85..e822519 100644 --- a/tests/byte.rs +++ b/tests/byte.rs @@ -1,7 +1,7 @@ use dir_embed::Embed; #[derive(Embed)] -#[dir = "./../testdata/"] +#[dir = "./../testdata/bytes/"] #[mode = "bytes"] pub struct Assets; @@ -41,3 +41,9 @@ fn byte_sub_directories_content() { let content_is = Assets::get("sub/file2.txt").unwrap(); assert_eq!(*content_is, *content_should); } + +#[test] +fn byte_read_bin() { + let file = Assets::get("bin").unwrap(); + assert_eq!(file, [0xDE, 0xAD, 0xBE, 0xEF]); +} diff --git a/tests/mime.rs b/tests/mime.rs new file mode 100644 index 0000000..d292951 --- /dev/null +++ b/tests/mime.rs @@ -0,0 +1,61 @@ +use dir_embed::Embed; + +#[derive(Embed)] +#[dir = "./../testdata/bytes/"] +#[mode = "mime"] +pub struct Assets; + +#[test] +fn mime_get() { + assert!(Assets::get("file1.txt").is_some()); +} + +#[test] +fn mime_get_missing() { + assert!(Assets::get("missing.txt").is_none()); +} + +#[test] +fn mime_read_content() { + let content_should = "file1".as_bytes(); + let content_is = Assets::get("file1.txt").unwrap(); + assert_eq!(*content_is.0, *content_should); +} + +#[test] +fn mime_parse_string() { + let file: &[u8] = Assets::get("file1.txt").expect("Can't find file").0; + let string = str::from_utf8(file).expect("Failed to parse file"); + + assert_eq!(string, "file1"); +} + +#[test] +fn mime_sub_directories_get() { + assert!(Assets::get("sub/file2.txt").is_some()); +} + +#[test] +fn mime_sub_directories_content() { + let content_should = "file2".as_bytes(); + let content_is = Assets::get("sub/file2.txt").unwrap(); + assert_eq!(*content_is.0, *content_should); +} + +#[test] +fn mime_type_html() { + let file = Assets::get("index.html").unwrap(); + assert_eq!(file.1, "text/html"); +} + +#[test] +fn mime_type_plain() { + let file = Assets::get("file1.txt").unwrap(); + assert_eq!(file.1, "text/plain"); +} + +#[test] +fn mime_default_type() { + let file = Assets::get("bin").unwrap(); + assert_eq!(file.1, "application/octet-stream"); +} diff --git a/tests/str.rs b/tests/str.rs index e81a2e0..5217b68 100644 --- a/tests/str.rs +++ b/tests/str.rs @@ -1,7 +1,7 @@ use dir_embed::Embed; #[derive(Embed)] -#[dir = "./../testdata/"] +#[dir = "./../testdata/str/"] #[mode = "str"] pub struct Assets;