Struct Config 

pub struct Config<S = DefaultStore> { /* private fields */ }

Thread-safe, immutable configuration container.

Design notes

• Configuration is parsed once and then treated as read-only.
• Internally, values are flattened into dot-separated keys: database.host, runners[0].name, etc.
• The backing store is wrapped in an Arc to make cloning cheap and sharing across threads trivial.

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

You can also use a custom store like:

use std::collections::HashMap;

use rustc_hash::FxBuildHasher;
use tomldir::{Config, Value};

let cfg = Config::<HashMap<String, Value, FxBuildHasher>>::from_file_with("config.toml");

Implementations

impl Config

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

Load configuration from a TOML file using the default store.

Errors

Returns an error if the file cannot be read or contains invalid TOML.

pub fn from_toml(content: &str) -> Result<Self>

Load configuration from a TOML string using the default store.

Errors

Returns an error if the string contains invalid TOML.

impl<S> Config<S>

where S: Store,

pub fn from_file_with<P: AsRef<Path>>(path: P) -> Result<Self>

Load configuration from a TOML file using a custom store.

Errors

Returns an error if the file cannot be read or contains invalid TOML.

pub fn from_toml_with(content: &str) -> Result<Self>

Load configuration from a TOML string using a custom store.

Errors

Returns an error if the string contains invalid TOML.

pub fn shared(&self) -> Self

Returns a new instance sharing the same underlying store.

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

Retrieve a raw TOML value by flattened key.

pub fn get_string(&self, key: &str) -> Option<&str>

Helper to get a String value.

pub fn get_int(&self, key: &str) -> Option<i64>

Helper to get an integer value.

pub fn get_float(&self, key: &str) -> Option<f64>

Helper to get a float value.

pub fn get_bool(&self, key: &str) -> Option<bool>

Helper to get a boolean value.

pub fn flatten(&self) -> impl Iterator<Item = (String, String)> + '_

Flatten all values into string form.

Strings preserve their raw content. Non-strings use TOML’s display representation.

pub fn flatten_into<C>(&self) -> C

where C: FromIterator<(String, String)>,

Returns a flattened collection of the configuration, where all values are converted to strings.

The return type C must implement FromIterator<(String, String)>.

Trait Implementations

impl<S> Clone for Config<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.