Struct PathResolver 

pub struct PathResolver {
    pub qualifier: &'static str,
    pub organization: &'static str,
    pub application: &'static str,
    pub cache_env_vars: &'static [&'static str],
    pub data_env_vars: &'static [&'static str],
}

Static configuration for application path resolution.

Fields

qualifier: &'static str

The qualifier for ProjectDirs.

organization: &'static str

The organization for ProjectDirs.

application: &'static str

The application for ProjectDirs.

cache_env_vars: &'static [&'static str]

The resolution order for cache directories environment variables.

data_env_vars: &'static [&'static str]

The resolution order for data directories environment variables.

Implementations

impl PathResolver

pub fn project_dirs(&self) -> Option<ProjectDirs>

Get the ProjectDirs for this config.

pub fn resolve_cache_dir<P: AsRef<Path>>( &self, path: Option<P>, ) -> Option<PathBuf>

Resolve the cache directory for this config.

Resolution Order:

1. path, if present.
2. env[$VAR] for each self.cache_env_vars; in order.
3. self.project_dirs().cache_dir(), if present.
4. None

Project Dirs Behavior

Platform	Value	Example
Linux	$XDG_CACHE_HOME/_project_path_ or $HOME/.cache/_project_path_	/home/alice/.cache/barapp
macOS	$HOME/Library/Caches/_project_path_	/Users/Alice/Library/Caches/com.Foo-Corp.Bar-App
Windows	{FOLDERID_LocalAppData}\_project_path_\cache	C:\Users\Alice\AppData\Local\Foo Corp\Bar App\cache

pub fn resolve_data_dir<P: AsRef<Path>>( &self, path: Option<P>, ) -> Option<PathBuf>

Resolve the data directory for this config.

Resolution Order:

1. path, if present.
2. env[$VAR] for each self.data_env_vars; in order.
3. self.project_dirs().data_dirs(), if present.
4. None

Project Dirs Behavior

Platform	Value	Example
Linux	$XDG_DATA_HOME/_project_path_ or $HOME/.local/share/_project_path_	/home/alice/.local/share/barapp
macOS	$HOME/Library/Application Support/_project_path_	/Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App
Windows	{FOLDERID_LocalAppData}\_project_path_\data	C:\Users\Alice\AppData\Local\Foo Corp\Bar App\data