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

未维护 trillium-include-dir

trillium.rs中使用的include_dir crate的临时分支

2个版本

0.1.1 2021年11月29日
0.1.0 2021年10月27日

#21 in #dir

MIT 许可证

14KB
256

include_dir

Build Status Build status license Crates.io Docs.rs

include_str!()include_bytes!()宏的演变,可以将整个目录树嵌入到你的二进制文件中。

渲染文档

入门

include_dir!()宏的工作方式与正常的include_str!()include_bytes!()宏非常相似。你将文件路径传递给宏,并将返回值分配给某个static变量。

最重要的是,文件路径必须相对于项目根目录,如环境变量CARGO_MANIFEST_DIR所示。

#[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());
    }
}

功能

  • 在编译时将目录树嵌入到你的二进制文件中
  • 在嵌入的目录中查找文件
  • 使用glob模式搜索文件(需要globs功能)

待办事项列表

  • 文件元数据
  • 压缩?

依赖

~1.5MB
~36K SLoC