xdir

About

This crate provides a minimal and opinionated library for retrieving platform-agnostic XDG-compliant standard locations of directories. Notably, this crate will always yield the same locations for subdirectories of the user's home regardless of platform-specific conventions, which is often more consistent with what users would expect from a command-line application.

If you are building an application that strictly follows the platform's conventions, the dirs crate provides platform-specific locations.

Usage

xdir provides a minimal API to return the standard location of a given directory. This allows users to configure where they would like certain files to be stored using environment variables as per the XDG Base Directory Specification.

For example, to get the configuration file of an application:

fn config() -> PathBuf {
    xdir::config()
        // Append the application name to the path to avoid cluttering the
        // general config directory.
        .map(|path| path.join("myapp"))
        // If the standard path could not be found (e.g.`$HOME` is not set),
        // default to the current directory.
        .unwrap_or_default()
        // Finally, append the config file to the directory path.
        .join("config.toml")
}

License

This project is dual-licensed under both MIT License and Apache License 2.0. You have permission to use this code under the conditions of either license pursuant to the rights granted by the chosen license.