Expand description
§static-files - the library to help automate static resource collection
§Legal
Dual-licensed under MIT or the UNLICENSE.
§Features
- Embed static resources in executuble
- Install dependencies with npm package manager
- Run custom
npmrun commands (such as webpack) - Support for npm-like package managers (yarn)
- Change detection support to reduce compilation time
§Usage
Create folder with static resources in your project (for example static):
cd project_dir
mkdir static
echo "Hello, world" > static/helloAdd to Cargo.toml dependency to static-files:
[dependencies]
static-files = "0.3"
[build-dependencies]
static-files = "0.3"Add build.rs with call to bundle resources:
use static_files::resource_dir;
fn main() -> std::io::Result<()> {
resource_dir("./static").build()
}Include generated code in main.rs:
include!(concat!(env!("OUT_DIR"), "/generated.rs"));
fn main() -> std::io::Result<()> {
let generated = generate(); // <-- this function is defined in generated.rs
// ...
Ok(())
}By default, ‘static-files’ collects all files in operation system defined order, but you can change it by activating ‘sort’ feature in Cargo.toml:
[dependencies]
static-files = { version = "0.3", features = ["sort"] }
[build-dependencies]
static-files = { version = "0.3", features = ["sort"] }Modules§
- resource
- Resource definition and single module based generation.
- sets
- Support for module based generations. Use it for large data sets (more than 128 Mb).
Structs§
- NpmBuild
- Executes
npmcommands before collecting resources. - Resource
- Static files resource.
- Resource
Dir - Resource dir.
Enums§
Functions§
- npm_
resource_ dir - Generate resources with run of
npm installprior to collecting resources inresource_dir. - resource_
dir - Generate resources for
resource_dir.