Struct EnvVar 

pub struct EnvVar {
    pub standard: String,
    pub legacy: Vec<String>,
    pub description: Option<String>,
}

Environment variable with optional legacy aliases.

Fields

standard: String

Standard (preferred) variable name.

legacy: Vec<String>

Legacy (deprecated) variable names.

description: Option<String>

Description for documentation/error messages.

Implementations

impl EnvVar

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

Create a new environment variable definition.

pub fn with_legacy(self, name: &str) -> Self

Add a legacy (deprecated) alias.

pub fn with_legacy_names(self, names: &[&str]) -> Self

Add multiple legacy aliases.

pub fn with_description(self, desc: &str) -> Self

Add a description.

pub fn get(&self) -> Option<String>

Get the value, checking standard name first, then legacy names.

If a legacy name is used, logs a deprecation warning.

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

Get the value with a default.

pub fn get_parsed<T: FromStr>(&self) -> Option<T>

Get the value, parsing to a specific type.

pub fn get_bool(&self) -> Option<bool>

Get the value as a boolean.

Accepts: “true”, “1”, “yes”, “on” (case-insensitive) as true.

pub fn get_list(&self) -> Option<Vec<String>>

Get the value as a comma-separated list.

pub fn which_name_used(&self) -> Option<&str>

Check which name was used (for debugging).

Trait Implementations

impl Clone for EnvVar

fn clone(&self) -> EnvVar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvVar

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

Formats the value using the given formatter.