qubit-config 0.8.4

Powerful type-safe configuration management with multi-value properties, variable substitution, and rich data type support
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

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026.
 *    Haixing Hu, Qubit Co. Ltd.
 *
 *    All rights reserved.
 *
 ******************************************************************************/
//! # Configurable Interface
//!
//! Provides the `Configurable` trait for types to have unified configuration
//! access and change callback interfaces.
//!
//! # Author
//!
//! Haixing Hu

use super::Config;

/// Configurable trait
///
/// Types that implement this trait can be configured using `Config`.
///
/// # Examples
///
/// ```rust,ignore
/// use qubit_config::{Config, Configurable};
///
/// struct Server { config: Config }
///
/// impl Configurable for Server {
///     fn config(&self) -> &Config {
///         &self.config
///     }
///     fn config_mut(&mut self) -> &mut Config {
///         &mut self.config
///     }
///     fn set_config(&mut self, config: Config) {
///         self.config = config;
///         self.on_config_changed();
///     }
/// }
/// ```
///
/// ```rust,ignore
/// use qubit_config::{ConfigResult, ConfigError};
/// ```
///
/// # Author
///
/// Haixing Hu
pub trait Configurable {
    /// Gets a reference to the configuration
    ///
    /// # Returns
    ///
    /// Returns an immutable reference to the configuration
    ///
    /// # Author
    ///
    /// Haixing Hu
    fn config(&self) -> &Config;

    /// Gets a mutable reference to the configuration
    ///
    /// # Returns
    ///
    /// Returns a mutable reference to the configuration
    ///
    /// # Author
    ///
    /// Haixing Hu
    fn config_mut(&mut self) -> &mut Config;

    /// Sets the configuration
    ///
    /// # Parameters
    ///
    /// * `config` - The new configuration
    ///
    /// # Returns
    ///
    /// Nothing.
    ///
    /// # Author
    ///
    /// Haixing Hu
    fn set_config(&mut self, config: Config);

    /// Callback after configuration changes
    ///
    /// This method is called when the configuration is modified. Implementors
    /// may override it to run side effects after [`Self::set_config`].
    ///
    /// # Returns
    ///
    /// Nothing.
    ///
    /// # Author
    ///
    /// Haixing Hu
    #[inline]
    fn on_config_changed(&mut self) {
        // Default implementation is empty
    }
}