hyperparameter 0.5.13

A high performance configuration system for Rust.
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

use std::path::Path;

use clap::Parser;
use config::{self, File};
use hyperparameter::*;

#[derive(Parser)]
#[command(after_long_help=generate_params_help())]
struct CommandLineArgs {
    /// Specifies hyperparameters in the format `-D key=value` via the command line.
    #[arg(short = 'D', long)]
    define: Vec<String>,

    /// Specifies the configuration file path.
    #[arg(short = 'C', long, default_value = "examples/cfg.toml")]
    config: String,
}

fn foo(desc: &str) {
    with_params! {
        /// Example param1 // this explain shows in `<app> --help`
        get param1 = example.param1 or "default".to_string();

        println!("param1={} // {}", param1, desc);
    }
}

fn main() {
    let args = CommandLineArgs::parse();
    let config_path = Path::new(&args.config);
    let config = config::Config::builder()
        .add_source(File::from(config_path))
        .build()
        .unwrap();

    foo("Outside any specific scope");

    with_params! { // Scope with configuration file parameters
        params config.param_scope();

        foo("Within configuration file scope");
        with_params! { // Scope with command-line arguments
            params ParamScope::from(&args.define);

            foo("Within command-line arguments scope");
            with_params! { // User-defined scope
                set example.param1= "scoped".to_string();

                foo("Within user-defined scope");
            }
        }
    }
}