Compare commits

..

1 Commits

Author SHA1 Message Date
6a64527022 version bump
now with str and bytes mode
2025-07-28 21:08:53 +02:00
13 changed files with 12 additions and 187 deletions

26
Cargo.lock generated
View File

@@ -4,31 +4,13 @@ version = 4
[[package]] [[package]]
name = "dir-embed" name = "dir-embed"
version = "0.1.1" version = "0.2.0"
dependencies = [ dependencies = [
"mime",
"mime_guess",
"proc-macro2", "proc-macro2",
"quote", "quote",
"syn", "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]] [[package]]
name = "proc-macro2" name = "proc-macro2"
version = "1.0.95" version = "1.0.95"
@@ -58,12 +40,6 @@ dependencies = [
"unicode-ident", "unicode-ident",
] ]
[[package]]
name = "unicase"
version = "2.8.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "75b844d17643ee918803943289730bec8aac480150456169e647ed0b576ba539"
[[package]] [[package]]
name = "unicode-ident" name = "unicode-ident"
version = "1.0.18" version = "1.0.18"

View File

@@ -1,6 +1,6 @@
[package] [package]
name = "dir-embed" name = "dir-embed"
version = "0.1.1" version = "0.2.0"
edition = "2024" edition = "2024"
license = "MIT" license = "MIT"
description = "Like include_bytes! for directories" description = "Like include_bytes! for directories"
@@ -11,12 +11,7 @@ readme = "README.md"
[lib] [lib]
proc-macro = true proc-macro = true
[features]
default = []
[dependencies] [dependencies]
mime = { version = "0.3.17" }
mime_guess = "2.0.5"
proc-macro2 = "1" proc-macro2 = "1"
quote = "1" quote = "1"
syn = { version = "2", features = ["full"] } syn = { version = "2", features = ["full"] }

View File

@@ -1,12 +1,8 @@
Simple way to use [`include_bytes!`](https://doc.rust-lang.org/std/macro.include_bytes.html) for directories. 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 # Example
You can embed files three ways. You can embed files two ways.
## Bytes mode ## Bytes mode
@@ -43,25 +39,3 @@ fn main(){
println!("{file}"); 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
}
```

View File

@@ -1,4 +1,3 @@
use mime::Mime;
use proc_macro::TokenStream; use proc_macro::TokenStream;
use quote::quote; use quote::quote;
use syn::spanned::Spanned; use syn::spanned::Spanned;
@@ -11,7 +10,6 @@ use std::path::{Path, PathBuf};
enum EmbedMode { enum EmbedMode {
Bytes, Bytes,
Str, Str,
BytesMime,
} }
#[proc_macro_derive(Embed, attributes(dir, mode))] #[proc_macro_derive(Embed, attributes(dir, mode))]
@@ -46,7 +44,6 @@ pub fn embed(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
for entry in collect_files(&absolue_path) { for entry in collect_files(&absolue_path) {
let rel_path = entry let rel_path = entry
.0
.strip_prefix(&absolue_path) .strip_prefix(&absolue_path)
.unwrap() .unwrap()
.to_str() .to_str()
@@ -59,40 +56,29 @@ pub fn embed(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
let arm = match mode { let arm = match mode {
EmbedMode::Bytes => generate_byte_arm(&rel_path, include_string), EmbedMode::Bytes => generate_byte_arm(&rel_path, include_string),
EmbedMode::Str => generate_str_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); match_arms.push(arm);
} }
#[allow(unused_mut)] let expanded = match mode {
let mut expanded = match mode {
EmbedMode::Bytes => generate_byte_impl(struct_name, match_arms), EmbedMode::Bytes => generate_byte_impl(struct_name, match_arms),
EmbedMode::Str => generate_str_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) proc_macro::TokenStream::from(expanded)
} }
fn collect_files(dir: &Path) -> Vec<(PathBuf, Option<Mime>)> { fn collect_files(dir: &Path) -> Vec<PathBuf> {
let mut files = Vec::new(); let mut files = Vec::new();
for entry in fs::read_dir(dir).unwrap() { for entry in fs::read_dir(dir).unwrap() {
let path = entry.unwrap().path(); let path = entry.unwrap().path();
if path.is_file() { if path.is_file() {
let mime_type = mime_guess::from_path(&path); files.push(path);
files.push((path, mime_type.first()));
} else if path.is_dir() { } else if path.is_dir() {
files.extend(collect_files(&path)); files.extend(collect_files(&path));
} }
} }
files files
} }
@@ -116,22 +102,21 @@ fn extract_dir_path(attr: &Attribute) -> String {
fn extract_mode(attr: &Attribute) -> EmbedMode { fn extract_mode(attr: &Attribute) -> EmbedMode {
let meta = match &attr.meta { let meta = match &attr.meta {
Meta::NameValue(meta) => meta, Meta::NameValue(meta) => meta,
_ => panic!("Expected #[mode = \"bytes\"|\"str\"|\"mime\"] as a name-value attribute."), _ => panic!("Expected #[mode = \"bytes\"|\"str\"] as a name-value attribute."),
}; };
let expr_lit = match &meta.value { let expr_lit = match &meta.value {
Expr::Lit(expr_lit) => expr_lit, Expr::Lit(expr_lit) => expr_lit,
_ => panic!("Expected #[mode = \"bytes\"|\"str\"|\"mime\"] with a string literal."), _ => panic!("Expected #[mode = \"bytes\"|\"str\"] with a string literal."),
}; };
match &expr_lit.lit { match &expr_lit.lit {
Lit::Str(str) => match str.value().as_str() { Lit::Str(str) => match str.value().as_str() {
"bytes" => EmbedMode::Bytes, "bytes" => EmbedMode::Bytes,
"str" => EmbedMode::Str, "str" => EmbedMode::Str,
"mime" => EmbedMode::BytesMime, other => panic!("Unknown mode: {other}. Use `bytes` or `str`."),
other => panic!("Unknown mode: {other}. Use `bytes`,`str` or `mime`."),
}, },
_ => panic!("Expected #[mode = \"bytes\"|\"str\"|\"mime\"] to be a string."), _ => panic!("Expected #[mode = \"bytes\"|\"str\"] to be a string."),
} }
} }
@@ -178,26 +163,3 @@ 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>,
) -> proc_macro2::TokenStream {
quote! {
impl #struct_name {
pub fn get(name: &str) -> Option<(&'static [u8],&'static str)> {
match name {
#(#match_arms)*
_ => None,
}
}
}
}
}

1
testdata/bytes/bin vendored
View File

@@ -1 +0,0 @@
゙ュセ<EFBFBD>

View File

@@ -1,12 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<title>Page Title</title>
</head>
<body>
<h1>This is a Heading</h1>
<p>This is a paragraph.</p>
</body>
</html>

View File

@@ -1 +0,0 @@
file1

View File

@@ -1 +0,0 @@
file2

View File

@@ -1,7 +1,7 @@
use dir_embed::Embed; use dir_embed::Embed;
#[derive(Embed)] #[derive(Embed)]
#[dir = "./../testdata/bytes/"] #[dir = "./../testdata/"]
#[mode = "bytes"] #[mode = "bytes"]
pub struct Assets; pub struct Assets;
@@ -41,9 +41,3 @@ fn byte_sub_directories_content() {
let content_is = Assets::get("sub/file2.txt").unwrap(); let content_is = Assets::get("sub/file2.txt").unwrap();
assert_eq!(*content_is, *content_should); assert_eq!(*content_is, *content_should);
} }
#[test]
fn byte_read_bin() {
let file = Assets::get("bin").unwrap();
assert_eq!(file, [0xDE, 0xAD, 0xBE, 0xEF]);
}

View File

@@ -1,61 +0,0 @@
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");
}

View File

@@ -1,7 +1,7 @@
use dir_embed::Embed; use dir_embed::Embed;
#[derive(Embed)] #[derive(Embed)]
#[dir = "./../testdata/str/"] #[dir = "./../testdata/"]
#[mode = "str"] #[mode = "str"]
pub struct Assets; pub struct Assets;