#directory #embed #assets #directory-tree #include #glob-pattern

unmaintained trillium-include-dir

temporary fork of the include_dir crate for use in trillium.rs

2 releases

0.1.1 Nov 29, 2021
0.1.0 Oct 27, 2021

#21 in #dir

MIT license

14KB
256 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

~1.5MB
~36K SLoC