7 unstable releases

0.6.1 Jun 30, 2021
0.6.0 May 5, 2020
0.5.0 Jan 13, 2020
0.4.1 Nov 5, 2019
0.2.1 Jun 6, 2018
Download history 13483/week @ 2021-04-07 8853/week @ 2021-04-14 9987/week @ 2021-04-21 8090/week @ 2021-04-28 10615/week @ 2021-05-05 12299/week @ 2021-05-12 8296/week @ 2021-05-19 9934/week @ 2021-05-26 11457/week @ 2021-06-02 17981/week @ 2021-06-09 21915/week @ 2021-06-16 18915/week @ 2021-06-23 14731/week @ 2021-06-30 19956/week @ 2021-07-07 14539/week @ 2021-07-14 13230/week @ 2021-07-21

54,376 downloads per month
Used in 160 crates (via include_dir)

MIT license

5KB
114 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.4–0.9MB
~21K SLoC