#include #tree #directory #build #static

includedir_codegen

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

7 releases (4 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.2.1 Feb 20, 2016

#43 in Filesystem

Download history 439/week @ 2020-05-27 707/week @ 2020-06-03 864/week @ 2020-06-10 1149/week @ 2020-06-17 495/week @ 2020-06-24 730/week @ 2020-07-01 523/week @ 2020-07-08 562/week @ 2020-07-15 839/week @ 2020-07-22 607/week @ 2020-07-29 762/week @ 2020-08-05 592/week @ 2020-08-12 702/week @ 2020-08-19 831/week @ 2020-08-26 757/week @ 2020-09-02 981/week @ 2020-09-09

2,509 downloads per month
Used in 10 crates (8 directly)

BSD-3-Clause

7KB
142 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

~1MB
~16K SLoC