Struct PrefPath 

pub struct PrefPath { /* private fields */ }

Preference path manager for OS-recommended preference/configuration directories.

Unlike AppPaths, PrefPath strictly follows OS-specific conventions:

• macOS: ~/Library/Preferences/
• Linux: ~/.config/ (XDG_CONFIG_HOME)
• Windows: %APPDATA%

Example

use version_migrate::PrefPath;

let pref = PrefPath::new("com.example.myapp");
let pref_file = pref.pref_file("settings.plist")?;
// On macOS: ~/Library/Preferences/com.example.myapp/settings.plist
// On Linux: ~/.config/com.example.myapp/settings.plist

Implementations

impl PrefPath

pub fn new(app_name: impl Into<String>) -> Self

Create a new preference path manager.

Arguments

• app_name - Application identifier (e.g., “com.example.myapp” for macOS bundle ID style)

Example

let pref = PrefPath::new("com.example.myapp");

pub fn pref_dir(&self) -> Result<PathBuf, MigrationError>

Get the preference directory path.

Creates the directory if it doesn’t exist.

Returns

The resolved preference directory path:

• macOS: ~/Library/Preferences/{app_name}
• Linux: ~/.config/{app_name}
• Windows: %APPDATA%\{app_name}

Errors

Returns MigrationError::HomeDirNotFound if the home directory cannot be determined. Returns MigrationError::IoError if directory creation fails.

Example

let pref_dir = pref.pref_dir()?;
// On macOS: ~/Library/Preferences/com.example.myapp

pub fn pref_file(&self, filename: &str) -> Result<PathBuf, MigrationError>

Get a preference file path.

This is a convenience method that joins the filename to the preference directory. Creates the parent directory if it doesn’t exist.

Arguments

• filename - The preference file name (e.g., “settings.plist”, “config.json”)

Example

let pref_file = pref.pref_file("settings.plist")?;
// On macOS: ~/Library/Preferences/com.example.myapp/settings.plist

Trait Implementations

impl Clone for PrefPath

fn clone(&self) -> PrefPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrefPath

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

Formats the value using the given formatter.