19 releases

0.7.4 Jun 17, 2024
0.7.3 Oct 16, 2022
0.7.2 Dec 6, 2021
0.7.1 Nov 19, 2021
0.1.3 Jun 10, 2017

#8 in Web programming

Download history 134234/week @ 2024-12-28 245972/week @ 2025-01-04 312065/week @ 2025-01-11 261797/week @ 2025-01-18 260685/week @ 2025-01-25 284203/week @ 2025-02-01 373514/week @ 2025-02-08 334438/week @ 2025-02-15 375949/week @ 2025-02-22 395061/week @ 2025-03-01 371518/week @ 2025-03-08 348690/week @ 2025-03-15 329663/week @ 2025-03-22 323278/week @ 2025-03-29 324553/week @ 2025-04-05 279425/week @ 2025-04-12

1,309,569 downloads per month
Used in 1,370 crates (365 directly)

MIT license

18KB
263 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

~86KB