1 unstable release

0.7.3 Sep 24, 2023

#6 in #include-dir

Download history 82/week @ 2024-03-11 108/week @ 2024-03-18 89/week @ 2024-03-25 103/week @ 2024-04-01 80/week @ 2024-04-08 107/week @ 2024-04-15 137/week @ 2024-04-22 156/week @ 2024-04-29 107/week @ 2024-05-06 112/week @ 2024-05-13 175/week @ 2024-05-20 86/week @ 2024-05-27 78/week @ 2024-06-03 62/week @ 2024-06-10 84/week @ 2024-06-17 89/week @ 2024-06-24

325 downloads per month
Used in 5 crates (via comfy_include_dir)

MIT license

12KB
301 lines

include_dir

Continuous Integration license Crates.io Docs.rs

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.

use include_dir::{include_dir, Dir};

static PROJECT_DIR: Dir = include_dir!("$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 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)
  • File metadata (requires the metadata feature)

To-Do list:

  • Compression?

Dependencies

~84KB