Struct UserEnv 

pub struct UserEnv {
    pub home: Option<Utf8PathBuf>,
    pub claude_config_dir: Option<Utf8PathBuf>,
    pub xdg_state_home: Option<Utf8PathBuf>,
    pub xdg_cache_home: Option<Utf8PathBuf>,
    pub plan_zone: Option<String>,
    pub docs_scratch: Option<String>,
}

What the process environment carries, read once and passed down.

Fields

home: Option<Utf8PathBuf>

The invoking user’s home directory.

claude_config_dir: Option<Utf8PathBuf>

Where Claude Code’s configuration directory was moved to.

xdg_state_home: Option<Utf8PathBuf>

The XDG state base directory.

xdg_cache_home: Option<Utf8PathBuf>

The XDG cache base directory.

plan_zone: Option<String>

What the plan-zone variable carries.

docs_scratch: Option<String>

What the docs-scratch variable carries.

Implementations

impl UserEnv

pub fn from_process() -> Self

Read every variable this module resolves from, once.

pub fn state_root(&self) -> Option<PathEntry>

The state root, through the XDG variable or its default.

pub fn legacy_state_root(&self) -> Option<Utf8PathBuf>

The home-relative state root, whatever the variable says.

One fallback read lives here: a receipt written before the state root followed XDG_STATE_HOME, and the two gate files that release left under the retired shared root.

pub fn cache_root(&self) -> Option<PathEntry>

The cache root, through the XDG variable or its default.

pub fn agent_root(&self, id: AgentId) -> Option<AgentRootEntry>

One agent skill root, resolved with what decided it.

pub fn agent_roots(&self, selected: &[AgentId]) -> Vec<AgentRootEntry>

Every selected agent root, in table order, deduplicated by path.

Two selected roots that resolve to one directory are one destination. Planning it twice would list every file twice and make an install compare a write against itself.

pub fn user_paths(&self) -> Option<UserPaths>

Every user-scope path, with every agent root selected.

Trait Implementations

impl Clone for UserEnv

fn clone(&self) -> UserEnv

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserEnv

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

Formats the value using the given formatter.

impl Default for UserEnv

fn default() -> UserEnv

Returns the “default value” for a type.

impl Eq for UserEnv

impl PartialEq for UserEnv

fn eq(&self, other: &UserEnv) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for UserEnv