#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

#1176 in Filesystem

Download history 1257/week @ 2024-11-21 1531/week @ 2024-11-28 2136/week @ 2024-12-05 2501/week @ 2024-12-12 1721/week @ 2024-12-19 1521/week @ 2024-12-26 2170/week @ 2025-01-02 2031/week @ 2025-01-09 2510/week @ 2025-01-16 1205/week @ 2025-01-23 658/week @ 2025-01-30 1486/week @ 2025-02-06 1563/week @ 2025-02-13 1994/week @ 2025-02-20 1925/week @ 2025-02-27 2120/week @ 2025-03-06

7,816 downloads per month
Used in 74 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

~425KB