macro comfy_include_dir_macros

The procedural macro used by include_dir

1 unstable release

0.7.3 Sep 24, 2023
Download history 96/week @ 2024-07-22 98/week @ 2024-07-29 73/week @ 2024-08-05 93/week @ 2024-08-12 84/week @ 2024-08-19 97/week @ 2024-08-26 95/week @ 2024-09-02 73/week @ 2024-09-09 66/week @ 2024-09-16 97/week @ 2024-09-23 74/week @ 2024-09-30 10/week @ 2024-10-07 65/week @ 2024-10-14 54/week @ 2024-10-21 67/week @ 2024-10-28 67/week @ 2024-11-04

253 downloads per month
Used in 5 crates (via comfy_include_dir)

MIT license

12KB
301 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

~77KB