#directory-tree #directory #static #compile-time #build #tree #include

includedir

Include a whole directory tree at compile time! - Runtime part

9 releases (5 breaking)

Uses old Rust 2015

0.6.0 May 27, 2020
0.5.0 Dec 14, 2018
0.4.0 Apr 9, 2018
0.3.0 Mar 12, 2018
0.1.1 Feb 16, 2016

#1145 in Filesystem

Download history 492/week @ 2024-07-04 1012/week @ 2024-07-11 1411/week @ 2024-07-18 1149/week @ 2024-07-25 1395/week @ 2024-08-01 1876/week @ 2024-08-08 1100/week @ 2024-08-15 1440/week @ 2024-08-22 1713/week @ 2024-08-29 794/week @ 2024-09-05 1153/week @ 2024-09-12 1438/week @ 2024-09-19 864/week @ 2024-09-26 626/week @ 2024-10-03 984/week @ 2024-10-10 2265/week @ 2024-10-17

5,062 downloads per month
Used in 73 crates (13 directly)

BSD-3-Clause

6KB
90 lines

includedir

Travis Appveyor Crates.io version docs.rs Crates.io license

Include a directory in your Rust binary, e.g. static files for your web server or assets for your game.

Features

  • Automatically compile data into binary
  • Use rust-phf for efficient lookup
  • Wrapping API around the phf map, to abstract away additional features
  • Compression, with optional crate "flate2"
  • Reading from source files for debug builds

Example

Cargo.toml

[package]
name = "example"
version = "0.1.0"

build = "build.rs"
include = ["data"]

[dependencies]
phf = "0.8.0"
includedir = "0.6.0"

[build-dependencies]
includedir_codegen = "0.6.0"

build.rs

extern crate includedir_codegen;

use includedir_codegen::Compression;

fn main() {
    includedir_codegen::start("FILES")
        .dir("data", Compression::Gzip)
        .build("data.rs")
        .unwrap();
}

src/main.rs

extern crate includedir;
extern crate phf;

use std::env;

include!(concat!(env!("OUT_DIR"), "/data.rs"));

fn main() {
    FILES.set_passthrough(env::var_os("PASSTHROUGH").is_some());

    println!("{:?}", FILES.get("data/foo"))
}

Dependencies

~420KB