Feature gate: #![feature(xdg_basedir)]

This is a tracking issue for API providing the XDG Base Directories in std::os::unix::xdg.

This is placed in os::unix because it is fundamentally intended to be an OS-specific API surface. Any portable directory conventions are necessarily restricted to only utilizing some widely available subset of conventions or porting one target's conventions to others' environments. This API is exposed such that programs have the option of specializing to the lower level platform-specific conventions.

Public API

// in std::os::unix::xdg (new module)

pub fn data_home_dir() -> PathBuf;
pub fn config_home_dir() -> PathBuf;
pub fn state_home_dir() -> PathBuf;
pub fn cache_home_dir() -> PathBuf;

#[derive(Debug, Clone)]
pub struct XdgDirsIter { /* ... */ };
impl Iterator for XdgDirsIter { /* ... */ }

pub fn data_dirs() -> XdgDirsIter;
pub fn config_dirs() -> XdgDirsIter;

Steps / History

(Remember to update the S-tracking-* label when checking boxes.)

• ACP: ACP: Add XDG Basedirs API to std::os::unix::xdg libs-team#805
• Implementation: Add xdg_basedir API #157518
• Final comment period (FCP)¹
• Stabilization PR

Unresolved Questions

• Should we provide runtime_dir (doesn't have a specified default) and/or bin_home_dir (has a specified default but the environment variable override is a common non-XDG-standard extension)?