Struct EnvConfigSource 

pub struct EnvConfigSource { /* private fields */ }

Configuration source that loads from system environment variables

Examples

use qubit_config::source::{EnvConfigSource, ConfigSource};
use qubit_config::Config;

// Load all env vars
let source = EnvConfigSource::new();

// Load only vars with prefix "APP_", strip prefix and normalize key
let source = EnvConfigSource::with_prefix("APP_");

let mut config = Config::new();
source.load(&mut config).unwrap();

Author

Haixing Hu

Implementations

impl EnvConfigSource

pub fn new() -> Self

Creates a new EnvConfigSource that loads all environment variables.

Keys are loaded as-is (no prefix filtering, no transformation).

Returns

A source that ingests every std::env::vars() entry.

pub fn with_prefix(prefix: &str) -> Self

Creates a new EnvConfigSource that filters by prefix and normalizes keys.

Only variables with the given prefix are loaded. The prefix is stripped, the key is lowercased, and underscores are converted to dots.

Parameters

• prefix - The prefix to filter by (e.g., "APP_")

Returns

A source with prefix filtering and key normalization enabled.

pub fn with_options( prefix: &str, strip_prefix: bool, convert_underscores: bool, lowercase_keys: bool, ) -> Self

Creates a new EnvConfigSource with a custom prefix and explicit options.

Parameters

• prefix - The prefix to filter by
• strip_prefix - Whether to strip the prefix from the key
• convert_underscores - Whether to convert underscores to dots
• lowercase_keys - Whether to lowercase the key

Returns

A configured EnvConfigSource.

Trait Implementations

impl Clone for EnvConfigSource

fn clone(&self) -> EnvConfigSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConfigSource for EnvConfigSource

fn load(&self, config: &mut Config) -> ConfigResult<()>

Loads configuration data into the provided Config object

impl Debug for EnvConfigSource

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

Formats the value using the given formatter.

impl Default for EnvConfigSource

fn default() -> Self

Returns the “default value” for a type.