11 unstable releases (3 breaking)

✓ Uses Rust 2018 edition

0.5.0 Jan 13, 2020
0.4.1 Nov 5, 2019
0.2.1 Jun 6, 2018
0.1.5 Feb 9, 2018
0.1.3 Jun 10, 2017

#8 in Development tools

Download history 461/week @ 2019-11-01 207/week @ 2019-11-08 289/week @ 2019-11-15 336/week @ 2019-11-22 387/week @ 2019-11-29 568/week @ 2019-12-06 2332/week @ 2019-12-13 1303/week @ 2019-12-20 1585/week @ 2019-12-27 3134/week @ 2020-01-03 2732/week @ 2020-01-10 1947/week @ 2020-01-17 2554/week @ 2020-01-24 2129/week @ 2020-01-31 3292/week @ 2020-02-07

4,180 downloads per month
Used in 18 crates (11 directly)

MIT license

9KB
170 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
#[cfg(feature = "search")]
{
    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–0.9MB
~20K SLoC