#include #tree #directory #build #static

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

#245 in Filesystem

Download history 2291/week @ 2022-08-11 2063/week @ 2022-08-18 1327/week @ 2022-08-25 2646/week @ 2022-09-01 2423/week @ 2022-09-08 2626/week @ 2022-09-15 2114/week @ 2022-09-22 1321/week @ 2022-09-29 2199/week @ 2022-10-06 1504/week @ 2022-10-13 2110/week @ 2022-10-20 2539/week @ 2022-10-27 2095/week @ 2022-11-03 1978/week @ 2022-11-10 2084/week @ 2022-11-17 1106/week @ 2022-11-24

7,766 downloads per month
Used in 57 crates (14 directly)

BSD-3-Clause

5KB
108 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

~395KB