Struct Config 

pub struct Config {
    pub version: String,
    pub profile: String,
    pub log_file_path: PathBuf,
    pub log_level: LogLevel,
    pub log_rotation: Option<LogRotation>,
    pub log_format: String,
    pub logging_destinations: Vec<LoggingDestination>,
    pub env_vars: HashMap<String, String>,
}

Configuration structure for the logging system.

Fields

version: String

Version of the configuration.

profile: String

Profile name for the configuration.

log_file_path: PathBuf

Path to the log file.

log_level: LogLevel

Log level for the system.

log_rotation: Option<LogRotation>

Log rotation settings.

log_format: String

Log format string.

logging_destinations: Vec<LoggingDestination>

Logging destinations for the system.

env_vars: HashMap<String, String>

Environment variables for the system.

Implementations

impl Config

pub fn hot_reload_async( config_path: &str, config: &Arc<RwLock<Self>>, ) -> Result<Sender<()>, ConfigError>

Available on crate feature tokio only.

Hot-reloads configuration on file change.

Polls the file every HOT_RELOAD_POLL_INTERVAL and reloads it when its modification time or size changes, including when an editor replaces it by renaming a new file over it. A file that fails to load leaves the current configuration in place. Send () on the returned channel, or drop it, to stop.

Requires the tokio feature and a running Tokio runtime.

Errors

Returns ConfigError::WatcherError if the file cannot be read when watching starts.

impl Config

pub fn load<P: AsRef<Path>>( config_path: Option<P>, ) -> Result<Arc<RwLock<Self>>, ConfigError>

Loads configuration from a file or falls back to defaults.

This is the synchronous variant. See Config::load_async for the async equivalent (requires the tokio feature).

Errors

Returns an error if the configuration file cannot be read, parsed, or if the version is unsupported.

pub async fn load_async<P: AsRef<Path>>( config_path: Option<P>, ) -> Result<Arc<RwLock<Self>>, ConfigError>

Available on crate feature tokio only.

Loads configuration from a file or environment variables (async).

Requires the tokio feature.

Errors

This function returns an error if the configuration file cannot be read, parsed, or if the version is unsupported.

pub fn save_to_file<P: AsRef<Path>>(&self, path: P) -> Result<(), ConfigError>

Saves the current configuration to a file in TOML format.

This matches the TOML format expected by Config::load.

Errors

This function returns an error if the file cannot be written or if serialization fails.

pub fn set<T: Serialize>( &mut self, key: &str, value: T, ) -> Result<(), ConfigError>

Sets a value in the configuration based on the specified key.

Errors

This function returns an error if the value cannot be serialized or if the key is unknown.

pub fn validate(&self) -> Result<(), ConfigError>

Validates the configuration settings.

Errors

This function returns an error if any configuration setting is invalid.

pub fn ensure_paths(&self) -> Result<(), ConfigError>

Creates directories and log files required by the configuration.

Errors

This function returns an error if the directories or files cannot be created.

pub fn expand_env_vars(&self) -> Self

Expands environment variables in the configuration values.

pub fn diff(config1: &Self, config2: &Self) -> HashMap<String, String>

Compares two configurations and returns the differences.

pub fn override_with(&self, other: &Self) -> Self

Overrides the current configuration with values from another configuration.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Vars> for Config

type Error = ConfigError

The type returned in the event of a conversion error.

fn try_from(vars: Vars) -> Result<Self, Self::Error>

Performs the conversion.