Struct Settings 

pub struct Settings { /* private fields */ }

Parsed KEY=VALUE settings plus where they came from.

Implementations

impl Settings

pub fn env_only() -> Self

No file; lookups consult the process environment only.

pub fn from_pairs<K: Into<String>, V: Into<String>>( pairs: impl IntoIterator<Item = (K, V)>, ) -> Self

Fixed values with no environment fallback (tests, generated configs).

pub fn parse(text: &str) -> Result<Self>

Parse settings text (see the module docs for the format).

pub fn load(path: &Path) -> Result<Self>

Load one file.

pub fn locate(root: &Path) -> Result<Option<PathBuf>>

The file Settings::discover would read for root, if any.

pub fn discover(root: &Path) -> Result<Self>

Load the first settings file in the documented search order; no file is not an error.

pub fn source(&self) -> Option<&Path>

The file these settings were read from.

pub fn with_env_override(self, on: bool) -> Self

Enable or disable the process-environment override.

pub fn set(&mut self, key: impl Into<String>, value: impl Into<String>)

Set or replace one value (file-level; the environment still wins when enabled).

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

Non-empty value for key: process environment first (when enabled), then the file.

pub fn get_or(&self, key: &str, default: &str) -> String

pub fn require(&self, key: &str) -> Result<String>

Present or an error naming the key and the file.

pub fn parse_value<T: FromStr>(&self, key: &str) -> Result<Option<T>>

where T::Err: Display,

Parsed value; Ok(None) when absent, an error when present but malformed.

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

1/true/yes/on or 0/false/no/off (case-insensitive); anything else is an error.

pub fn get_u64(&self, key: &str) -> Result<Option<u64>>

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

pub fn get_list(&self, key: &str) -> Vec<String>

Comma-separated list, items trimmed, empties dropped.

pub fn get_path(&self, key: &str, base: &Path) -> Option<PathBuf>

A path; a relative value resolves against base (usually the app root).

pub fn keys(&self) -> impl Iterator<Item = &str>

File-level keys (environment overrides are not listed).

Trait Implementations

impl Clone for Settings

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 Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.