codify_hoijui 0.6.0

Helps in automatic code generation at compile-time, for initializing structs and enums containing data, which is to be available at runtime.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

<!--
SPDX-FileCopyrightText: 2022 - 2023 Robin Vobruba <hoijui.quaero@gmail.com>

SPDX-License-Identifier: CC0-1.0
-->

# codify-rs

[![License: AGPL-3.0-or-later](
    https://img.shields.io/badge/License-AGPL%203.0+-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)

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:
    ```
    [dependencies]
    codify = { version = "0.3", package = "codify_hoijui" }

    [build-dependencies]
    codify = { version = "0.3", 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.