# codify-rs
[![License: AGPL-3.0-or-later](
https://img.shields.io/badge/License-AGPL--3.0--or--later-blue.svg)](
LICENSE.txt)
[![REUSE status](
https://api.reuse.software/badge/github.com/hoijui/codify-rs)](
https://api.reuse.software/info/github.com/hoijui/codify-rs)
[![Repo](
https://img.shields.io/badge/GitHub-green?style=flat&label=Repo)](
https://github.com/hoijui/codify-rs)
[![Statistics](
https://img.shields.io/badge/Statistics-8946FF?style=flat&label=lib.rs&labelColor=EEEEEE)](
https://lib.rs/codify_hoijui)
[![Package Releases](
https://img.shields.io/crates/v/codify_hoijui.svg?color=fc8d62&logo=rust)](
https://crates.io/crates/codify_hoijui)
[![Documentation Releases](
https://img.shields.io/badge/docs.rs-codify_hoijui-66c2a5?labelColor=555555&logo=docs.rs)](
https://docs.rs/codify_hoijui)
[![Dependency Status](
https://deps.rs/repo/github/hoijui/codify-rs/status.svg)](
https://deps.rs/repo/github/hoijui/codify-rs)
[![Build Status](
https://github.com/hoijui/codify-rs/workflows/build/badge.svg)](
https://github.com/hoijui/codify-rs/actions)
Helps in automatic code generation at compile-time,
for initializing structs and enums containing data,
which is to be available at runtime.
The practical use case of this,
is to store resources/data in the binary in the most efficient form,
so it will be ready at runtime,
without having to include the data/files
in their original, serialized, potentially innefficient form
into the binary.
This also means, the data does not have to be parsed
at runtime/application-startup.
## Usage
0. Add this library to your normal and build dependencies in cargo:
```toml
[dependencies]
codify = { version = "0.6", package = "codify_hoijui" }
[build-dependencies]
codify = { version = "0.6", package = "codify_hoijui" }
```
1. in your `build.rs`, load some data from resource files
into structs/enums, using serde
2. in your `build.rs`, call `Codify::init_code()` on that data,
creating init code.
3. write that code into a `$OUT_DIR/my_data_x_gen.rs` file
4. Create a proxy source file under `src/` -
for example `src/my_data_x_gen.rs` -
which does nothing more then include the generated file:
`include!(concat!(env!("OUT_DIR"), "/my_data_x_gen.rs"));`
5. load/use `$OUT_DIR/my_data_x.rs` file at compile-time
## Example
For an example usage,
see the [build.rs](
https://github.com/hoijui/osh-dir-std-rs/blob/master/build.rs)
file of [osh-dir-std-rs](
https://github.com/hoijui/osh-dir-std-rs/) project.