6 releases (3 breaking)

✓ Uses Rust 2018 edition

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 2966/week @ 2020-01-25 3504/week @ 2020-02-01 2888/week @ 2020-02-08 3085/week @ 2020-02-15 2939/week @ 2020-02-22 5842/week @ 2020-02-29 6188/week @ 2020-03-07 6118/week @ 2020-03-14 7448/week @ 2020-03-21 5753/week @ 2020-03-28 3189/week @ 2020-04-04 4006/week @ 2020-04-11 4489/week @ 2020-04-18 4308/week @ 2020-04-25 4379/week @ 2020-05-02 4492/week @ 2020-05-09

19,599 downloads per month
Used in 44 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.5–0.8MB
~18K SLoC