cfgmatic 1.1.0

High-level configuration management framework for Rust with derive macros and validation
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

//! Test for cfgmatic with complex types (`HashMap`, nested structs)
//!
//! This test verifies that cfgmatic works correctly with structs containing
//! complex types that don't implement `FromStr`.

use cfgmatic::Config;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Complex config with `HashMap` and nested structs
#[derive(Debug, Clone, Deserialize, Serialize, Config)]
#[config(prefix = "TEST")]
pub struct ComplexConfig {
    /// Simple field with config attribute
    #[config(default = "8080")]
    pub port: u16,

    /// Complex field WITHOUT config attribute - should be skipped
    pub registry: HashMap<String, ModelDefinition>,

    /// Nested struct WITHOUT config attribute - should be skipped
    pub nested: NestedConfig,
}

impl Default for ComplexConfig {
    fn default() -> Self {
        let mut registry = HashMap::new();
        registry.insert(
            "default".to_string(),
            ModelDefinition {
                name: "default-model".to_string(),
                dimensions: 1536,
            },
        );

        Self {
            port: 8080,
            registry,
            nested: NestedConfig::default(),
        }
    }
}

/// Model definition (stored in `HashMap`)
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ModelDefinition {
    pub name: String,
    pub dimensions: usize,
}

/// Nested configuration struct
#[derive(Debug, Clone, Deserialize, Serialize, Config)]
pub struct NestedConfig {
    /// Field with config attribute in nested struct
    #[config(default = "true")]
    pub enabled: bool,

    /// Field without config attribute
    pub value: Option<String>,
}

impl Default for NestedConfig {
    fn default() -> Self {
        Self {
            enabled: true,
            value: None,
        }
    }
}

fn main() {
    println!("Testing cfgmatic with complex types...\n");

    // Test: Default config
    let config = ComplexConfig::default();
    println!("Default config:");
    println!("  port: {}", config.port);
    println!(
        "  registry keys: {:?}",
        config.registry.keys().collect::<Vec<_>>()
    );
    println!("  nested.enabled: {}", config.nested.enabled);
    println!();

    // Verify default values
    assert_eq!(config.port, 8080, "Port should have default value");
    assert!(
        config.registry.contains_key("default"),
        "Registry should have default value"
    );
    assert!(
        config.nested.enabled,
        "Nested enabled should have default value"
    );

    println!("All checks passed!");
    println!();
    println!("The Config derive macro correctly:");
    println!("- Processes fields with #[config(...)] attributes");
    println!("- Skips complex fields (HashMap) without #[config(...)]");
    println!("- Skips nested structs without #[config(...)]");
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_complex_config_default() {
        let config = ComplexConfig::default();
        assert_eq!(config.port, 8080);
        assert!(config.registry.contains_key("default"));
        assert!(config.nested.enabled);
    }

    #[test]
    fn test_hashmap_field_preserved() {
        // This test verifies that HashMap fields are skipped by the macro
        // If they weren't, the struct wouldn't compile
        let config = ComplexConfig::default();

        // HashMap should retain its default value
        assert!(config.registry.contains_key("default"));
        assert_eq!(config.registry["default"].dimensions, 1536);
    }
}