8 releases
0.6.2 | Sep 2, 2021 |
---|---|
0.6.1 | Jun 30, 2021 |
0.6.0 | May 5, 2020 |
0.5.0 | Jan 13, 2020 |
0.2.1 | Jun 6, 2018 |
#5 in #include-dir
170,725 downloads per month
6KB
114 lines
include_dir
An evolution of the include_str!()
and include_bytes!()
macros for embedding
an entire directory tree into your binary.
Rendered Documentation:
Getting Started
The include_dir!()
macro works very similarly to the normal include_str!()
and include_bytes!()
macros. You pass the macro a file path and assign the
returned value to some static
variable.
Most importantly, the file path must be relative to the project root as
indicated by the CARGO_MANIFEST_DIR
environment variable.
#[macro_use]
extern crate include_dir;
use include_dir::Dir;
use std::path::Path;
static PROJECT_DIR: Dir = include_dir!(".");
// of course, you can retrieve a file by its full path
let lib_rs = PROJECT_DIR.get_file("src/lib.rs").unwrap();
// you can also inspect the file's contents
let body = lib_rs.contents_utf8().unwrap();
assert!(body.contains("SOME_INTERESTING_STRING"));
// you can search for files (and directories) using glob patterns
#[cfg(feature = "search")]
{
let glob = "**/*.rs";
for entry in PROJECT_DIR.find(glob).unwrap() {
println!("Found {}", entry.path().display());
}
}
Features
- Embed a directory tree into your binary at compile time
- Find a file in the embedded directory
- Search for files using a glob pattern (requires the
globs
feature)
To-Do list:
- File metadata
- Compression?
Dependencies
~1.5MB
~37K SLoC