[][src]Crate packer

packer is a library that helps you pack static files into binaries using macro magic. Here's how it's done:

Step 1: Include

Include the crate in your Cargo.toml:

packer = "0.5"

Step 2: Derive

Start deriving Packer from your structs. You need to provide a source attribute to indicate the directory from which it should be pulling. Paths are relative to the crate root.

use packer::Packer;
#[packer(source = "tests/basic")]
struct Assets;

Step 3: Use it!

You can now access any file using the get function:

use packer::Packer;
let data: Option<&'static [u8]> = Assets::get("kermit.jpg");

You may also choose to list all the files that have been stored.

use packer::Packer;
let files /*: impl Iterator<Item = &'static str>*/ = Assets::list();
// Result (with no guarantee of order):
// files = ["tests/basic/first/kermit.jpg", "tests/basic/second/ignored.x", "tests/basic/second/LICENSE"]

(See the documentation for the Packer trait for the full listing of methods.)

When you build in dev mode, it will fetch off your filesystem as usual, but when you build with --release, it will pack the assets into your binary!

Ignoring Paths

You can choose to ignore certain paths using the ignore option:

#[packer(source = "tests/basic/second", ignore = "*.x")]
struct Assets;

// using BTreeSet since there's no guarantee of order

Stripping the Prefix

By default, the path will keep the prefix. For example, if your file is located at static/index.html relative to your project root, then the path that's in the packed version will also be static/index.html. If you would like it to instead be just index.html, configure the prefixed option as follows:

#[packer(source = "tests/basic", prefixed = false)]
struct Assets;

By default, this option is set to true.