Struct VtCodePaths 

pub struct VtCodePaths { /* private fields */ }

Validated native/XDG storage roots and typed VT Code child paths.

Implementations

impl VtCodePaths

pub fn from_env() -> Result<Self>

Resolves paths from the process environment.

pub fn resolve() -> Result<Self>

Alias for Self::from_env, useful during startup resolution.

pub fn from_environment(environment: &[(&str, &str)]) -> Result<Self>

Resolves paths from an explicit environment, suitable for deterministic tests.

pub fn config_dir(&self) -> &Path

Canonical directory for user configuration.

pub fn data_dir(&self) -> &Path

Canonical directory for durable user data.

pub fn state_dir(&self) -> &Path

Canonical directory for durable mutable state.

pub fn cache_dir(&self) -> &Path

Canonical directory for recreatable cached data.

pub fn runtime_dir(&self) -> &Path

Private directory for runtime-only files.

pub fn executable_dir(&self) -> &Path

User executable helper directory.

pub fn system_config_dirs(&self) -> &[PathBuf]

System configuration candidates, lowest priority first.

pub fn system_data_dirs(&self) -> &[PathBuf]

System data candidates without an application suffix.

pub fn system_config_paths( &self, relative: impl AsRef<Path>, ) -> Result<Vec<PathBuf>>

Resolves a relative config path against all system candidates in low-to-high precedence order. system_config_dirs() retains the XDG preference order, where the first directory is most important.

pub fn system_data_paths( &self, relative: impl AsRef<Path>, ) -> Result<Vec<PathBuf>>

Resolves a relative data path against all system candidates.

pub fn legacy_home_dir(&self) -> &Path

Legacy global VT Code root, used only as a migration source.

pub fn legacy_dir(&self) -> &Path

Alias for Self::legacy_home_dir using the public contract name.

pub fn config_path(&self, relative: impl AsRef<Path>) -> Result<PathBuf>

Resolve a relative child path under the canonical configuration root.

pub fn data_path(&self, relative: impl AsRef<Path>) -> Result<PathBuf>

Resolve a relative child path under the canonical data root.

pub fn state_path(&self, relative: impl AsRef<Path>) -> Result<PathBuf>

Resolve a relative child path under the persistent state root.

pub fn cache_path(&self, relative: impl AsRef<Path>) -> Result<PathBuf>

Resolve a relative child path under the cache root.

pub fn runtime_path(&self, relative: impl AsRef<Path>) -> Result<PathBuf>

Resolve a relative child path under the runtime root.

pub fn executable_path(&self, relative: impl AsRef<Path>) -> Result<PathBuf>

Resolve a relative child path under the managed executable root.

pub fn config_file(&self) -> PathBuf

Main user configuration file.

pub fn skills_dir(&self) -> PathBuf

User-installed and downloaded skills.

pub fn plugins_dir(&self) -> PathBuf

User-installed plugins.

pub fn auth_dir(&self) -> PathBuf

Private authentication storage.

pub fn auth_file(&self) -> PathBuf

Legacy plaintext authentication file location.

pub fn logs_dir(&self) -> PathBuf

Durable log files.

pub fn sessions_dir(&self) -> PathBuf

Persisted cross-workspace session data.

pub fn telemetry_dir(&self) -> PathBuf

Telemetry storage.

pub fn migration_marker_path(&self) -> PathBuf

Completion marker for one-time legacy migration.

pub fn migration_report_path(&self) -> PathBuf

Versioned diagnostic report emitted alongside the completion marker.

pub fn ensure_runtime_dir(&self) -> Result<&Path>

Creates the runtime directory with private permissions.

pub fn ensure_config_dir(&self) -> Result<&Path>

Creates the canonical user configuration directory when needed. Existing directories retain their permissions.

pub fn ensure_data_dir(&self) -> Result<&Path>

Creates the canonical user data directory when needed. Existing directories retain their permissions.

pub fn ensure_state_dir(&self) -> Result<&Path>

Creates the canonical user state directory when needed. Existing directories retain their permissions.

pub fn ensure_cache_dir(&self) -> Result<&Path>

Creates the canonical user cache directory when needed. Existing directories retain their permissions.

pub fn ensure_executable_dir(&self) -> Result<&Path>

Creates the managed executable directory when needed. Existing directories retain their permissions.

pub fn ensure_user_dir(path: impl AsRef<Path>) -> Result<PathBuf>

Creates an arbitrary user-owned directory without following symlinks. Existing directories retain their permissions; newly created Unix directories use mode 0700.

pub fn create_private_file(path: impl AsRef<Path>) -> Result<File>

Creates a new private file without following a final symlink.

The parent is validated component by component before the file is opened. This is the common primitive for caches, locks, and other category-owned files that must never be redirected through a symlink.

pub fn open_private_append_file(path: impl AsRef<Path>) -> Result<File>

Opens an append-only private file without following a final symlink.

pub fn read_file_no_follow(path: impl AsRef<Path>) -> Result<Vec<u8>>

Reads a regular file without following a final symlink.

pub fn write_private_file_atomic( path: impl AsRef<Path>, contents: &[u8], ) -> Result<()>

Atomically writes a private file, replacing an existing regular file.

The destination is never opened for writing. A private, exclusive temporary file is written and then renamed into place, so a pre-existing symlink cannot redirect the contents outside the approved parent.

pub fn ensure_runtime_child_dir( &self, relative: impl AsRef<Path>, ) -> Result<PathBuf>

Creates a private runtime child directory after validating its path.

pub fn ensure_config_child_dir( &self, relative: impl AsRef<Path>, ) -> Result<PathBuf>

Creates a user configuration child directory after validating its path.

pub fn ensure_data_child_dir( &self, relative: impl AsRef<Path>, ) -> Result<PathBuf>

Creates a user data child directory after validating its path.

pub fn ensure_state_child_dir( &self, relative: impl AsRef<Path>, ) -> Result<PathBuf>

Creates a user state child directory after validating its path.

pub fn ensure_cache_child_dir( &self, relative: impl AsRef<Path>, ) -> Result<PathBuf>

Creates a user cache child directory after validating its path.

pub fn ensure_executable_child_dir( &self, relative: impl AsRef<Path>, ) -> Result<PathBuf>

Creates a managed executable child directory after validating its path.

pub fn ensure_auth_dir(&self) -> Result<PathBuf>

Creates private auth storage and returns its path.

pub fn create_auth_file(&self, name: impl AsRef<str>) -> Result<PathBuf>

Creates an empty, private auth file. The name must not contain a path.

pub fn migrate_legacy(&self) -> Result<MigrationReport>

Copies eligible legacy global data without modifying its source.

Trait Implementations

impl Clone for VtCodePaths

fn clone(&self) -> VtCodePaths

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VtCodePaths

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

Formats the value using the given formatter.

impl Eq for VtCodePaths

impl PartialEq for VtCodePaths

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for VtCodePaths