Struct Config 

pub struct Config { /* private fields */ }

Available on crate feature config only.

Configuration loading and management.

The TOML content is parsed once on creation and cached internally, so repeated calls to get and has_key are cheap lookups rather than full re-parses.

Implementations

impl Config

pub fn new(content: &str) -> Self

Create a new configuration from TOML string content.

Arguments

• content - TOML formatted configuration string

Example

use commons::config::Config;

let config = Config::new(r#"
    name = "app"
    port = 8080
"#);

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, ConfigError>

Load configuration from a TOML file.

Arguments

• path - Path to the TOML configuration file

Errors

Returns an error if the file cannot be read.

Example

use commons::config::Config;

let config = Config::from_file("config.toml").unwrap();

pub fn parse<T: DeserializeOwned>(&self) -> Result<T, ConfigError>

Parse the configuration into a typed struct.

Errors

Returns an error if the configuration cannot be parsed into the target type.

Example

use commons::config::Config;
use serde::Deserialize;

#[derive(Debug, Deserialize)]
struct MyConfig {
    name: String,
}

let config = Config::new("name = \"test\"");
let parsed: MyConfig = config.parse().unwrap();
assert_eq!(parsed.name, "test");

pub fn get<T: FromTomlValue>(&self, key: &str) -> Option<T>

Get a value from the configuration by key path.

Supports nested keys using dot notation: “section.key”

Example

use commons::config::Config;

let config = Config::new(r#"
    [server]
    port = 8080
"#);
let port: Option<i64> = config.get("server.port");
assert_eq!(port, Some(8080));

pub fn has_key(&self, key: &str) -> bool

Check if a key exists in the configuration.

pub fn raw(&self) -> &str

Get the raw TOML content.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

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.