#toml #cfg #constant #across #values #configuring #procedural

macro toml-cfg

A procedural macro for configuring constant values across crates

5 releases

0.2.0 Feb 21, 2024
0.1.3 Jan 11, 2022
0.1.2 Jan 11, 2022
0.1.1 Jan 11, 2022
0.1.0 Jan 11, 2022

#616 in Procedural macros

Download history 1098/week @ 2023-12-21 1044/week @ 2023-12-28 966/week @ 2024-01-04 958/week @ 2024-01-11 835/week @ 2024-01-18 680/week @ 2024-01-25 445/week @ 2024-02-01 532/week @ 2024-02-08 782/week @ 2024-02-15 638/week @ 2024-02-22 739/week @ 2024-02-29 1137/week @ 2024-03-07 1476/week @ 2024-03-14 1353/week @ 2024-03-21 929/week @ 2024-03-28 794/week @ 2024-04-04

4,796 downloads per month
Used in 3 crates

MIT/Apache

11KB
134 lines

toml-cfg

Rough ideas:

  • Crates can declare variables that can be overridden
    • Anything const, e.g. usize, strings, etc.
  • (Only) The "root crate" can override these variables by including a cfg.toml file

Config file

# a toml-cfg file

[lib-one]
buffer_size = 4096

[lib-two]
greeting = "Guten tag!"

In the library

// lib-one
#[toml_cfg::toml_config]
pub struct Config {
    #[default(32)]
    buffer_size: usize,
}

// lib-two
#[toml_cfg::toml_config]
pub struct Config {
    #[default("hello")]
    greeting: &'static str,
}

Look at what we get!

# Print the "buffer_size" value from the `lib-one` crate.
# Since it has no cfg.toml, we just get the default value.
$ cd pkg-example/lib-one
$ cargo run
    Finished dev [unoptimized + debuginfo] target(s) in 0.01s
     Running `target/debug/lib-one`
32

# Print the "greeting" value from the `lib-two` crate.
# Since it has no cfg.toml, we just get the default value.
$ cd ../lib-two
$ cargo run
   Compiling lib-two v0.1.0 (/home/james/personal/toml-cfg/pkg-example/lib-two)
    Finished dev [unoptimized + debuginfo] target(s) in 0.32s
     Running `target/debug/lib-two`
hello

# Print the "buffer_size" value from `lib-one`, and "greeting"
# from `lib-two`. Since we HAVE defined a `cfg.toml` file, the
# values defined there are used instead.
$ cd ../application
$ cargo run
   Compiling lib-two v0.1.0 (/home/james/personal/toml-cfg/pkg-example/lib-two)
   Compiling application v0.1.0 (/home/james/personal/toml-cfg/pkg-example/application)
    Finished dev [unoptimized + debuginfo] target(s) in 0.30s
     Running `target/debug/application`
4096
Guten tag!

Dependencies

~0.6–1.2MB
~27K SLoC