1 unstable release
0.1.0 | Feb 16, 2023 |
---|
186 downloads per month
Used in include_directory
12KB
283 lines
include_directory
An evolution of the include_str!()
and include_bytes!()
macros for embedding
an entire directory tree into your binary.
This is a fork of the include_dir
crate which gathers files' mimetype at compile-time that can be accessed at run-time.
Rendered Documentation:
Getting Started
The include_directory!()
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.
use include_directory::{include_directory, Dir};
static PROJECT_DIR: Dir = include_directory!("$CARGO_MANIFEST_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 get the mimetype by doing
let mimetype = lib_rs.mimetype();
// 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 = "glob")]
{
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) - Gather file's mimetype at compile-time
- File metadata (requires the
metadata
feature)
To-Do list:
- Compression?
lib.rs
:
Implementation details of the include_directory
.
You probably don't want to use this crate directly.
Dependencies
~295KB