Struct Paths 

pub struct Paths { /* private fields */ }

Home-derived file locations under ~/.purple and ~/.ssh. One place that knows the on-disk layout; every consumer asks here instead of joining the home directory itself.

The purple files live in four category directories (see Category). Paths::new puts all four at ~/.purple; Paths::resolve honors the PURPLE_*_DIR and XDG_*_HOME variables per category.

Implementations

impl Paths

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

The legacy layout: every category under ~/.purple.

pub fn resolve( home: impl Into<PathBuf>, var: impl Fn(&str) -> Option<String>, ) -> Self

Resolve each category directory from the environment. Precedence per category: PURPLE_<CATEGORY>_DIR when set and non-empty (a leading ~/ expands to the home directory), then $XDG_<CATEGORY>_HOME/purple when that variable is set, non-empty and absolute (a relative XDG path is invalid per the spec and ignored), else the legacy ~/.purple.

pub fn home(&self) -> &Path

pub fn legacy_dir(&self) -> PathBuf

~/.purple, the single directory every category used before the split. Only the migration reads from here.

pub fn dir(&self, category: Category) -> &Path

The directory a category resolved to.

pub fn config_dir(&self) -> &Path

Preferences, snippets, providers and themes.

pub fn data_dir(&self) -> &Path

Signed certificates and the original SSH config backup.

pub fn state_dir(&self) -> &Path

History, recents, ledgers, logs and retry markers.

pub fn cache_dir(&self) -> &Path

Container cache and version check.

pub fn is_split(&self) -> bool

True when at least one category lives outside ~/.purple.

pub fn preferences(&self) -> PathBuf

<config>/preferences.

pub fn snippets_file(&self) -> PathBuf

<config>/snippets, the INI-style snippet store.

pub fn providers_config(&self) -> PathBuf

<config>/providers, the provider config file.

pub fn themes_dir(&self) -> PathBuf

<config>/themes, the custom theme directory.

pub fn certs_dir(&self) -> PathBuf

<data>/certs.

pub fn cert_for(&self, alias: &str) -> PathBuf

<data>/certs/<alias>-cert.pub.

pub fn config_original(&self) -> PathBuf

<data>/config.original, the untouched SSH config backup taken on the first launch.

pub fn history(&self) -> PathBuf

<state>/history.tsv.

pub fn recents(&self) -> PathBuf

<state>/recents.json.

pub fn key_activity(&self) -> PathBuf

<state>/key_activity.json.

pub fn snippet_runs(&self) -> PathBuf

<state>/snippet_runs.json.

pub fn sync_history(&self) -> PathBuf

<state>/sync_history.tsv.

pub fn log_file(&self) -> PathBuf

<state>/purple.log.

pub fn mcp_audit_log(&self) -> PathBuf

<state>/mcp-audit.log.

pub fn askpass_marker(&self, alias: &str) -> PathBuf

Askpass retry marker <state>/.askpass_<safe>. The alias is sanitized (/, \, . become _) to prevent path traversal.

pub fn askpass_withheld_marker(&self, alias: &str) -> PathBuf

Marker recording that a background run met a prompt it could not place. The dot after withheld keeps this apart from a retry marker, whose own sanitizer turns every dot into an underscore. The alias is percent-encoded rather than flattened, so web.prod and web_prod keep their own file and neither can walk out of the state directory.

pub fn askpass_pin_request_marker(&self, flow: &str, alias: &str) -> PathBuf

Marker recording that a background run met a security key PIN prompt it had no PIN for. Keyed on the flow that ran it, so a container refresh never answers for a tunnel. Holds the key path.

pub fn askpass_pin_used_marker(&self, alias: &str) -> PathBuf

Marker listing which ssh process received which security key PIN for alias, one <pid>\t<key path> line each.

pub fn askpass_pin_refused_marker(&self, key_digest: &str) -> PathBuf

Marker recording that a security key refused the PIN purple handed out. Keyed on a digest of the key path, which is free to be long.

pub fn askpass_pin_last_marker(&self, key_digest: &str) -> PathBuf

Marker whose mtime is the last time askpass handed out the PIN of one security key, in any run. Keyed on the key path digest.

pub fn askpass_pin_lock_marker(&self, key_digest: &str) -> PathBuf

Lock file that queues the hand-outs of one security key’s PIN.

pub fn container_cache(&self) -> PathBuf

<cache>/container_cache.jsonl.

pub fn last_version_check(&self) -> PathBuf

<cache>/last_version_check.

pub fn aws_credentials_file(&self) -> PathBuf

~/.aws/credentials, the shared AWS credentials file.

pub fn aws_config_file(&self) -> PathBuf

~/.aws/config, the shared AWS config file. Named profiles live here as [profile <name>], and it is the only file that carries the assume-role keys.

pub fn ssh_dir(&self) -> PathBuf

~/.ssh.

pub fn abbreviate_home(&self, path: &Path) -> String

path for display, with the home directory abbreviated to ~.

Trait Implementations

impl Clone for Paths

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 Paths

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

Formats the value using the given formatter.

impl Eq for Paths

impl PartialEq for Paths

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Paths