4 releases

Uses new Rust 2021

0.7.3 Oct 16, 2022
0.7.2 Dec 6, 2021
0.7.1 Nov 19, 2021
0.7.0 Nov 14, 2021

#1375 in Procedural macros

Download history 17943/week @ 2022-08-10 20748/week @ 2022-08-17 18766/week @ 2022-08-24 14824/week @ 2022-08-31 17080/week @ 2022-09-07 17899/week @ 2022-09-14 18377/week @ 2022-09-21 25338/week @ 2022-09-28 26217/week @ 2022-10-05 26719/week @ 2022-10-12 34224/week @ 2022-10-19 28531/week @ 2022-10-26 32147/week @ 2022-11-02 29330/week @ 2022-11-09 27906/week @ 2022-11-16 18591/week @ 2022-11-23

112,636 downloads per month
Used in 263 crates (via include_dir)

MIT license

11KB
279 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

~105KB