Rust跨平台目录获取库platform-dirs使用指南

platform-dirs是一个Rust库，用于跨平台获取标准目录路径，如用户配置目录、缓存目录、数据目录等。它遵循各操作系统的标准规范，让开发者无需关心不同平台的路径差异。

安装

在Cargo.toml中添加依赖：

[dependencies]
platform-dirs = "2.0"

基本用法

1. 获取平台目录实例

use platform_dirs::PlatformDirs;

let dirs = PlatformDirs::new();

2. 获取各种标准目录

// 用户配置目录 (如Linux的~/.config, Windows的%APPDATA%)
let config_dir = dirs.config_dir;

// 用户数据目录 (如Linux的~/.local/share, Windows的%LOCALAPPDATA%)
let data_dir = dirs.data_dir;

// 用户缓存目录 (如Linux的~/.cache, Windows的%LOCALAPPDATA%\cache)
let cache_dir = dirs.cache_dir;

// 用户日志目录 (如Linux的~/.local/state, Windows的%LOCALAPPDATA%\log)
let state_dir = dirs.state_dir;

// 用户下载目录 (如Linux的~/Downloads, Windows的%USERPROFILE%\Downloads)
let download_dir = dirs.download_dir;

// 用户文档目录 (如Linux的~/Documents, Windows的%USERPROFILE%\Documents)
let document_dir = dirs.document_dir;

// 用户桌面目录
let desktop_dir = dirs.desktop_dir;

// 用户音乐目录
let music_dir = dirs.music_dir;

// 用户图片目录
let picture_dir = dirs.picture_dir;

// 用户视频目录
let video_dir = dirs.video_dir;

3. 创建应用特定目录

use platform_dirs::AppDirs;

// 为你的应用创建特定目录
let app_dirs = AppDirs::new("my-app", true).unwrap();

// 应用配置目录
let app_config_dir = app_dirs.config_dir;

// 应用数据目录
let app_data_dir = app_dirs.data_dir;

// 应用缓存目录
let app_cache_dir = app_dirs.cache_dir;

// 应用状态目录
let app_state_dir = app_dirs.state_dir;

完整示例

use platform_dirs::{PlatformDirs, AppDirs};
use std::fs;

fn main() {
    // 获取平台标准目录
    let dirs = PlatformDirs::new();
    println!("Config dir: {:?}", dirs.config_dir);
    println!("Cache dir: {:?}", dirs.cache_dir);
    
    // 创建应用特定目录
    let app_dirs = AppDirs::new("my-rust-app", true).unwrap();
    
    // 确保目录存在
    fs::create_dir_all(&app_dirs.config_dir).unwrap();
    fs::create_dir_all(&app_dirs.data_dir).unwrap();
    
    println!("App config dir: {:?}", app_dirs.config_dir);
    println!("App data dir: {:?}", app_dirs.data_dir);
}

平台支持

platform-dirs支持以下平台：

• Windows
• macOS
• Linux
• FreeBSD
• OpenBSD
• NetBSD
• DragonFly BSD
• Redox

注意事项

1. 某些目录在某些平台上可能不存在，使用前最好检查或创建目录
2. 对于应用特定目录，建议使用AppDirs而不是直接使用PlatformDirs
3. AppDirs::new的第二个参数表示是否应该创建目录

这个库简化了跨平台应用中处理标准目录的问题，让你的应用能更好地遵循各操作系统的文件系统规范。

完整示例demo

以下是基于上述内容的完整示例demo，展示了如何使用platform-dirs库获取各种目录并创建应用特定目录：

use platform_dirs::{PlatformDirs, AppDirs};
use std::fs;
use std::path::Path;

fn main() {
    // 1. 获取平台标准目录
    let platform_dirs = PlatformDirs::new();
    
    // 打印各种标准目录路径
    println!("=== 平台标准目录 ===");
    println!("配置目录: {:?}", platform_dirs.config_dir);
    println!("数据目录: {:?}", platform_dirs.data_dir);
    println!("缓存目录: {:?}", platform_dirs.cache_dir);
    println!("状态目录: {:?}", platform_dirs.state_dir);
    println!("下载目录: {:?}", platform_dirs.download_dir);
    println!("文档目录: {:?}", platform_dirs.document_dir);
    println!("桌面目录: {:?}", platform_dirs.desktop_dir);
    
    // 2. 创建应用特定目录
    let app_name = "my-rust-app";
    let create_dirs = true; // 自动创建目录
    let app_dirs = AppDirs::new(app_name, create_dirs).expect("无法创建应用目录");
    
    println!("\n=== 应用特定目录 ===");
    println!("应用配置目录: {:?}", app_dirs.config_dir);
    println!("应用数据目录: {:?}", app_dirs.data_dir);
    println!("应用缓存目录: {:?}", app_dirs.cache_dir);
    println!("应用状态目录: {:?}", app_dirs.state_dir);
    
    // 3. 检查目录是否存在或创建它们
    let dirs_to_check = [
        &app_dirs.config_dir,
        &app_dirs.data_dir,
        &app_dirs.cache_dir,
        &app_dirs.state_dir,
    ];
    
    for dir in dirs_to_check.iter() {
        if !dir.exists() {
            fs::create_dir_all(dir).expect(&format!("无法创建目录: {:?}", dir));
            println!("已创建目录: {:?}", dir);
        } else {
            println!("目录已存在: {:?}", dir);
        }
    }
    
    // 4. 在实际应用中使用这些目录
    let config_file = app_dirs.config_dir.join("config.toml");
    if !config_file.exists() {
        fs::write(&config_file, "# 默认配置").expect("无法创建配置文件");
        println!("\n已创建默认配置文件: {:?}", config_file);
    }
    
    let cache_file = app_dirs.cache_dir.join("cache.dat");
    fs::write(&cache_file, "缓存数据").expect("无法创建缓存文件");
    println!("已创建缓存文件: {:?}", cache_file);
}

这个完整示例展示了：

1. 如何获取平台的标准目录
2. 如何创建应用特定目录
3. 如何检查目录是否存在并创建它们
4. 如何在实际应用中使用这些目录来存储配置和缓存文件

运行此程序将在各平台的标准位置创建应用目录和文件，确保应用遵循操作系统的文件系统规范。