Effortlessly embed TOML files into your Rust code as static data with custom data structures.
Embed TOML files into your Rust binaries via a procedural macro. This library enables the inclusion of TOML files at compile-time and generates static data structures that can be directly accessed by your Rust code without the need for runtime parsing.
First, make sure to add static-toml to your Cargo.toml dependencies:
Either by command line:
shell
cargo add static-toml
Or by adding it to your Cargo.toml directly:
toml
[dependencies]
static-toml = "1"
Then, make use of the static_toml! macro to include your TOML file:
```rust
use statictoml::statictoml;
statictoml! { static CONFIG = includetoml!("config.toml"); } ``` This will read your TOML file and generate Rust data structures accordingly.
You can configure how the macro should generate data types:
rust
static_toml! {
#[static_toml(
prefix = Prefix,
suffix = Suffix,
root_mod = cfg,
values_ident = items,
prefer_slices = false
)]
static CONFIG = include_toml!("config.toml");
}
prefix:
Adds a prefix to the generated data types.
It's recommended to use PascalCase for the prefix.
suffix:
Similar to prefix, but itβs a suffix.
root_mod:
Sets the identifier for the root module that will contain the data types for
the TOML file.
values_ident:
When generating data types for arrays, this specifies a different name for
the modules and data types (default is values).
prefer_slices:
Determines whether the macro should generate fixed-size slices for arrays.
If set to false, tuples will be generated (default is true).
You can use doc comments, derive attributes, and other attributes. Additionally, you can set visibility. Your code can be clean and descriptive.
rust
static_toml! {
/// The configuration.
#[derive(Debug)]
#[allow(missing_docs)]
pub static CONFIG = include_toml!("config.toml");
}
Encounter compile errors?
No worries.
static-toml provides informative error messages, whether it's TOML parsing or
file access issues.
Suppose you have a simple TOML file like this: ```toml
[database] url = "localhost" port = 5432 ```
Use the static_toml! macro:
rust
static_toml! {
static CONFIG = include_toml!("config.toml");
}
And just like that, you have Rust data structures ready to use.
rust
assert_eq!(CONFIG.database.url, "localhost");
assert_eq!(CONFIG.database.port, 5432);