4 releases

new 0.4.1 Nov 5, 2019
0.4.0 Nov 4, 2019
0.2.1 Jun 6, 2018
0.2.0 Jun 6, 2018
Download history 194/week @ 2019-07-23 152/week @ 2019-07-30 140/week @ 2019-08-06 162/week @ 2019-08-13 149/week @ 2019-08-20 80/week @ 2019-08-27 125/week @ 2019-09-03 167/week @ 2019-09-10 182/week @ 2019-09-17 237/week @ 2019-09-24 104/week @ 2019-10-01 176/week @ 2019-10-08 284/week @ 2019-10-15 508/week @ 2019-10-22 307/week @ 2019-10-29

876 downloads per month
Used in 15 crates (1 directly)

MIT license

5KB
119 lines

include_dir

Build Status Build status 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.

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
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

~0.6–1MB
~21K SLoC