Struct TomlFileSource 

pub struct TomlFileSource { /* private fields */ }

Available on crate feature conf and native only.

TOML file configuration source

Implementations

impl TomlFileSource

pub fn new(path: impl Into<PathBuf>) -> TomlFileSource

Create a new TOML file configuration source.

${VAR} interpolation is enabled by default because the vast majority of real-world settings files (secrets, per-environment hosts, 12-factor overrides) require it. Call Self::without_interpolation to opt out and preserve raw TOML strings verbatim.

See Self::with_interpolation for the supported syntax.

Examples

use reinhardt_conf::settings::sources::TomlFileSource;
use std::path::PathBuf;

// Interpolation enabled by default — `${VAR}` is substituted from env.
let source = TomlFileSource::new(PathBuf::from("config.toml"));

pub fn with_interpolation(self) -> TomlFileSource

Explicitly opt in to ${VAR} interpolation.

This is a no-op for the default state — interpolation is on by default since 0.1.0-rc.27. The method exists so call sites can document intent or re-enable interpolation after a previous Self::without_interpolation call in a builder chain.

Supported syntax (applied to every toml::Value::String in the tree):

Token	Meaning
${VAR}	required — fails if VAR is unset or empty
${VAR:-default}	substitutes default if VAR is unset or empty
${VAR:?message}	fails with message if VAR is unset or empty
$$	escape — produces a literal $

Only string nodes are scanned, but the walker recurses into nested tables and arrays. Numeric, boolean, and datetime values are never rewritten.

Examples

use reinhardt_conf::settings::sources::TomlFileSource;
use std::path::PathBuf;

let source = TomlFileSource::new(PathBuf::from("settings.toml"))
    .with_interpolation();

pub fn without_interpolation(self) -> TomlFileSource

Opt out of ${VAR} interpolation and keep all TOML strings as literal values.

Use this when you intend ${...} substrings to survive the load — for example, when the configuration is itself a template that downstream code expands later.

Examples

use reinhardt_conf::settings::sources::TomlFileSource;
use std::path::PathBuf;

let source = TomlFileSource::new(PathBuf::from("template.toml"))
    .without_interpolation();

pub fn set_interpolation(self, enabled: bool) -> TomlFileSource

👎Deprecated since 0.1.0-rc.27:

Use with_interpolation()/without_interpolation() instead; will be removed in 0.2.0 (issue #4224)

Set interpolation explicitly via a boolean flag.

This is the legacy 0.1.0-rc API surface. New code should use Self::with_interpolation / Self::without_interpolation instead.

Trait Implementations

impl ConfigSource for TomlFileSource

fn load(&self) -> Result<IndexMap<String, Value>, SourceError>

Load configuration from this source

fn priority(&self) -> u8

Get the priority of this source (higher = more important)

fn description(&self) -> String

Get a description of this source