Struct Env 

pub struct Env { /* private fields */ }

The resolved environment for one process run: the home-derived paths plus a snapshot of the process environment variables. Built once via Env::from_process and passed down by reference (or Arc) rather than re-read on demand.

Implementations

impl Env

pub fn from_process() -> Self

Capture the real process environment: the home directory and a snapshot of all environment variables. The single point where production reads std::env and dirs::home_dir. The category directories resolve from the same snapshot.

pub fn for_test(home: impl Into<PathBuf>) -> Self

A test environment rooted at home with the legacy layout and no environment variables. Add variables with Env::with_var, swap the layout with Env::with_paths.

pub fn empty() -> Self

An environment with neither a home directory nor variables. Models the rare case where dirs::home_dir() returns None.

pub fn with_var(self, key: impl Into<String>, value: impl Into<String>) -> Self

Builder: set a variable. Chainable, for test construction.

pub fn with_paths(self, paths: Paths) -> Self

Builder: replace the paths, e.g. with a split layout from Paths::resolve. Chainable, for test construction.

pub fn paths(&self) -> Option<&Paths>

Home-derived paths, or None when the home directory is unknown.

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

Raw lookup of an arbitrary variable. Used by SSH config ${VAR} expansion, which references user-chosen names.

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

VAULT_ADDR fallback for Vault SSH address resolution.

pub fn aws_credentials(&self) -> Option<(&str, &str)>

(AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY) when both are set.

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

AWS_SESSION_TOKEN, set alongside temporary STS credentials.

pub fn aws_credentials_file(&self) -> Option<PathBuf>

Where the shared AWS credentials file lives. AWS_SHARED_CREDENTIALS_FILE relocates it; otherwise it is ~/.aws/credentials.

pub fn aws_config_file(&self) -> Option<PathBuf>

Where the shared AWS config file lives. AWS_CONFIG_FILE relocates it; otherwise it is ~/.aws/config.

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

PURPLE_TOKEN, the self-invocation auth token. A variable that is exported but blank (export PURPLE_TOKEN="$UNSET") reads as absent: it is ambient shell state, not a token the caller supplied.

pub fn no_color(&self) -> bool

True when NO_COLOR is present (any value), per the no-color convention.

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

COLORTERM.

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

TERM_PROGRAM.

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

TERM.

pub fn in_tmux(&self) -> bool

True when running inside tmux (TMUX is set).

pub fn active_proxy_vars(&self) -> Vec<&'static str>

Proxy-related variable names that are set to a non-empty value, in a stable order. Drives the startup banner’s proxy summary.

pub fn command(&self, program: &str) -> Command

Build a Command for program whose environment is exactly this Env’s snapshot. In production the snapshot is the full process environment captured at startup, so the subprocess sees the same env it would have inherited. Tests construct an Env with only the vars they care about (e.g. a stub-binary PATH), so subprocess resolution and env-dependent behaviour are controlled without mutating the process-global env (no unsafe set_var, no lock).

Trait Implementations

impl Clone for Env

fn clone(&self) -> Env

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Env

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

Formats the value using the given formatter.