1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
//! The _directories_ crate is //! //! - a tiny library with a minimal API (3 structs, 4 factory functions, getters) //! - that provides the platform-specific, user-accessible locations //! - for finding and storing configuration, cache and other data //! - on Linux, Redox, Windows (≥ Vista) and macOS. //! //! The library provides the location of these directories by leveraging the mechanisms defined by //! //! - the [XDG base directory](https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) and the [XDG user directory](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/) specifications on Linux, //! - the [Known Folder](https://msdn.microsoft.com/en-us/library/windows/desktop/bb776911(v=vs.85).aspx) system on Windows, and //! - the [Standard Directories](https://developer.apple.com/library/content/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html#//apple_ref/doc/uid/TP40010672-CH2-SW6) on macOS. //! #![deny(missing_docs)] #![warn(rust_2018_idioms)] use cfg_if::cfg_if; use std::path::Path; use std::path::PathBuf; cfg_if! { if #[cfg(target_os = "windows")] { mod win; use win as sys; } else if #[cfg(any(target_os = "macos", target_os = "ios"))] { mod mac; use mac as sys; } else if #[cfg(target_arch = "wasm32")] { mod wasm; use wasm as sys; } else { mod lin; use crate::lin as sys; } } /// `BaseDirs` provides paths of user-invisible standard directories, following the conventions of the operating system the library is running on. /// /// To compute the location of cache, config or data directories for individual projects or applications, use `ProjectDirs` instead. /// /// # Examples /// /// All examples on this page are computed with a user named _Alice_. /// /// ``` /// use directories_next::BaseDirs; /// if let Some(base_dirs) = BaseDirs::new() { /// base_dirs.config_dir(); /// // Linux: /home/alice/.config /// // Windows: C:\Users\Alice\AppData\Roaming /// // macOS: /Users/Alice/Library/Preferences /// } /// ``` #[derive(Debug, Clone)] pub struct BaseDirs { // home directory home_dir: PathBuf, // base directories cache_dir: PathBuf, config_dir: PathBuf, data_dir: PathBuf, data_local_dir: PathBuf, executable_dir: Option<PathBuf>, runtime_dir: Option<PathBuf>, } /// `UserDirs` provides paths of user-facing standard directories, following the conventions of the operating system the library is running on. /// /// # Examples /// /// All examples on this page are computed with a user named _Alice_. /// /// ``` /// use directories_next::UserDirs; /// if let Some(user_dirs) = UserDirs::new() { /// user_dirs.audio_dir(); /// // Linux: /home/alice/Music /// // Windows: C:\Users\Alice\Music /// // macOS: /Users/Alice/Music /// } /// ``` #[derive(Debug, Clone)] pub struct UserDirs { // home directory home_dir: PathBuf, // user directories audio_dir: Option<PathBuf>, desktop_dir: Option<PathBuf>, document_dir: Option<PathBuf>, download_dir: Option<PathBuf>, font_dir: Option<PathBuf>, picture_dir: Option<PathBuf>, public_dir: Option<PathBuf>, template_dir: Option<PathBuf>, // trash_dir: PathBuf, video_dir: Option<PathBuf>, } /// `ProjectDirs` computes the location of cache, config or data directories for a specific application, /// which are derived from the standard directories and the name of the project/organization. /// /// # Examples /// /// All examples on this page are computed with a user named _Alice_, /// and a `ProjectDirs` struct created with `ProjectDirs::from("com", "Foo Corp", "Bar App")`. /// /// ``` /// use directories_next::ProjectDirs; /// if let Some(proj_dirs) = ProjectDirs::from("com", "Foo Corp", "Bar App") { /// proj_dirs.config_dir(); /// // Linux: /home/alice/.config/barapp /// // Windows: C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App /// // macOS: /Users/Alice/Library/Preferences/com.Foo-Corp.Bar-App /// } /// ``` #[derive(Debug, Clone)] pub struct ProjectDirs { project_path: PathBuf, // base directories cache_dir: PathBuf, config_dir: PathBuf, data_dir: PathBuf, data_local_dir: PathBuf, runtime_dir: Option<PathBuf>, } impl BaseDirs { /// Creates a `BaseDirs` struct which holds the paths to user-invisible directories for cache, config, etc. data on the system. /// /// The returned value depends on the operating system and is either /// - `Some`, containing a snapshot of the state of the system's paths at the time `new()` was invoked, or /// - `None`, if no valid home directory path could be retrieved from the operating system. /// /// To determine whether a system provides a valid `$HOME` path, the following rules are applied: /// /// ### Linux and macOS: /// /// - Use `$HOME` if it is set and not empty. /// - If `$HOME` is not set or empty, then the function `getpwuid_r` is used to determine /// the home directory of the current user. /// - If `getpwuid_r` lacks an entry for the current user id or the home directory field is empty, /// then the function returns `None`. /// /// ### Windows: /// /// - Retrieve the user profile folder using `SHGetKnownFolderPath`. /// - If this fails, then the function returns `None`. /// /// _Note:_ This logic differs from [`std::env::home_dir`], /// which works incorrectly on Linux, macOS and Windows. /// /// [`std::env::home_dir`]: https://doc.rust-lang.org/std/env/fn.home_dir.html pub fn new() -> Option<BaseDirs> { sys::base_dirs() } /// Returns the path to the user's home directory. /// /// |Platform | Value | Example | /// | ------- | -------------------- | -------------- | /// | Linux | `$HOME` | /home/alice | /// | macOS | `$HOME` | /Users/Alice | /// | Windows | `{FOLDERID_Profile}` | C:\Users\Alice | pub fn home_dir(&self) -> &Path { self.home_dir.as_path() } /// Returns the path to the user's cache directory. /// /// |Platform | Value | Example | /// | ------- | ----------------------------------- | ---------------------------- | /// | Linux | `$XDG_CACHE_HOME` or `$HOME`/.cache | /home/alice/.cache | /// | macOS | `$HOME`/Library/Caches | /Users/Alice/Library/Caches | /// | Windows | `{FOLDERID_LocalAppData}` | C:\Users\Alice\AppData\Local | pub fn cache_dir(&self) -> &Path { self.cache_dir.as_path() } /// Returns the path to the user's config directory. /// /// |Platform | Value | Example | /// | ------- | ------------------------------------- | -------------------------------- | /// | Linux | `$XDG_CONFIG_HOME` or `$HOME`/.config | /home/alice/.config | /// | macOS | `$HOME`/Library/Preferences | /Users/Alice/Library/Preferences | /// | Windows | `{FOLDERID_RoamingAppData}` | C:\Users\Alice\AppData\Roaming | pub fn config_dir(&self) -> &Path { self.config_dir.as_path() } /// Returns the path to the user's data directory. /// /// |Platform | Value | Example | /// | ------- | ---------------------------------------- | ---------------------------------------- | /// | Linux | `$XDG_DATA_HOME` or `$HOME`/.local/share | /home/alice/.local/share | /// | macOS | `$HOME`/Library/Application Support | /Users/Alice/Library/Application Support | /// | Windows | `{FOLDERID_RoamingAppData}` | C:\Users\Alice\AppData\Roaming | pub fn data_dir(&self) -> &Path { self.data_dir.as_path() } /// Returns the path to the user's local data directory. /// /// |Platform | Value | Example | /// | ------- | ---------------------------------------- | ---------------------------------------- | /// | Linux | `$XDG_DATA_HOME` or `$HOME`/.local/share | /home/alice/.local/share | /// | macOS | `$HOME`/Library/Application Support | /Users/Alice/Library/Application Support | /// | Windows | `{FOLDERID_LocalAppData}` | C:\Users\Alice\AppData\Local | pub fn data_local_dir(&self) -> &Path { self.data_local_dir.as_path() } /// Returns the path to the user's executable directory. /// /// |Platform | Value | Example | /// | ------- | ---------------------------------------------------------------- | ---------------------- | /// | Linux | `$XDG_BIN_HOME` or `$XDG_DATA_HOME`/../bin or `$HOME`/.local/bin | /home/alice/.local/bin | /// | macOS | – | – | /// | Windows | – | – | pub fn executable_dir(&self) -> Option<&Path> { self.executable_dir.as_ref().map(|p| p.as_path()) } /// Returns the path to the user's runtime directory. /// /// |Platform | Value | Example | /// | ------- | ------------------ | --------------- | /// | Linux | `$XDG_RUNTIME_DIR` | /run/user/1001/ | /// | macOS | – | – | /// | Windows | – | – | pub fn runtime_dir(&self) -> Option<&Path> { self.runtime_dir.as_ref().map(|p| p.as_path()) } } impl UserDirs { /// Creates a `UserDirs` struct which holds the paths to user-facing directories for audio, font, video, etc. data on the system. /// /// The returned value depends on the operating system and is either /// - `Some`, containing a snapshot of the state of the system's paths at the time `new()` was invoked, or /// - `None`, if no valid home directory path could be retrieved from the operating system. /// /// To determine whether a system provides a valid `$HOME` path, please refer to [`BaseDirs::new`] pub fn new() -> Option<UserDirs> { sys::user_dirs() } /// Returns the path to the user's home directory. /// /// |Platform | Value | Example | /// | ------- | -------------------- | -------------- | /// | Linux | `$HOME` | /home/alice | /// | macOS | `$HOME` | /Users/Alice | /// | Windows | `{FOLDERID_Profile}` | C:\Users\Alice | pub fn home_dir(&self) -> &Path { self.home_dir.as_path() } /// Returns the path to the user's audio directory. /// /// |Platform | Value | Example | /// | ------- | ------------------ | -------------------- | /// | Linux | `XDG_MUSIC_DIR` | /home/alice/Music | /// | macOS | `$HOME`/Music | /Users/Alice/Music | /// | Windows | `{FOLDERID_Music}` | C:\Users\Alice\Music | pub fn audio_dir(&self) -> Option<&Path> { self.audio_dir.as_ref().map(|p| p.as_path()) } /// Returns the path to the user's desktop directory. /// /// |Platform | Value | Example | /// | ------- | -------------------- | ---------------------- | /// | Linux | `XDG_DESKTOP_DIR` | /home/alice/Desktop | /// | macOS | `$HOME`/Desktop | /Users/Alice/Desktop | /// | Windows | `{FOLDERID_Desktop}` | C:\Users\Alice\Desktop | pub fn desktop_dir(&self) -> Option<&Path> { self.desktop_dir.as_ref().map(|p| p.as_path()) } /// Returns the path to the user's document directory. /// /// |Platform | Value | Example | /// | ------- | ---------------------- | ------------------------ | /// | Linux | `XDG_DOCUMENTS_DIR` | /home/alice/Documents | /// | macOS | `$HOME`/Documents | /Users/Alice/Documents | /// | Windows | `{FOLDERID_Documents}` | C:\Users\Alice\Documents | pub fn document_dir(&self) -> Option<&Path> { self.document_dir.as_ref().map(|p| p.as_path()) } /// Returns the path to the user's download directory. /// /// |Platform | Value | Example | /// | ------- | ---------------------- | ------------------------ | /// | Linux | `XDG_DOWNLOAD_DIR` | /home/alice/Downloads | /// | macOS | `$HOME`/Downloads | /Users/Alice/Downloads | /// | Windows | `{FOLDERID_Downloads}` | C:\Users\Alice\Downloads | pub fn download_dir(&self) -> Option<&Path> { self.download_dir.as_ref().map(|p| p.as_path()) } /// Returns the path to the user's font directory. /// /// |Platform | Value | Example | /// | ------- | ---------------------------------------------------- | ------------------------------ | /// | Linux | `$XDG_DATA_HOME`/fonts or `$HOME`/.local/share/fonts | /home/alice/.local/share/fonts | /// | macOS | `$HOME`/Library/Fonts | /Users/Alice/Library/Fonts | /// | Windows | – | – | pub fn font_dir(&self) -> Option<&Path> { self.font_dir.as_ref().map(|p| p.as_path()) } /// Returns the path to the user's picture directory. /// /// |Platform | Value | Example | /// | ------- | --------------------- | ----------------------- | /// | Linux | `XDG_PICTURES_DIR` | /home/alice/Pictures | /// | macOS | `$HOME`/Pictures | /Users/Alice/Pictures | /// | Windows | `{FOLDERID_Pictures}` | C:\Users\Alice\Pictures | pub fn picture_dir(&self) -> Option<&Path> { self.picture_dir.as_ref().map(|p| p.as_path()) } /// Returns the path to the user's public directory. /// /// |Platform | Value | Example | /// | ------- | --------------------- | ------------------- | /// | Linux | `XDG_PUBLICSHARE_DIR` | /home/alice/Public | /// | macOS | `$HOME`/Public | /Users/Alice/Public | /// | Windows | `{FOLDERID_Public}` | C:\Users\Public | pub fn public_dir(&self) -> Option<&Path> { self.public_dir.as_ref().map(|p| p.as_path()) } /// Returns the path to the user's template directory. /// /// |Platform | Value | Example | /// | ------- | ---------------------- | ---------------------------------------------------------- | /// | Linux | `XDG_TEMPLATES_DIR` | /home/alice/Templates | /// | macOS | – | – | /// | Windows | `{FOLDERID_Templates}` | C:\Users\Alice\AppData\Roaming\Microsoft\Windows\Templates | pub fn template_dir(&self) -> Option<&Path> { self.template_dir.as_ref().map(|p| p.as_path()) } /// Returns the path to the user's video directory. /// /// |Platform | Value | Example | /// | ------- | ------------------- | --------------------- | /// | Linux | `XDG_VIDEOS_DIR` | /home/alice/Videos | /// | macOS | `$HOME`/Movies | /Users/Alice/Movies | /// | Windows | `{FOLDERID_Videos}` | C:\Users\Alice\Videos | pub fn video_dir(&self) -> Option<&Path> { self.video_dir.as_ref().map(|p| p.as_path()) } } impl ProjectDirs { /// Creates a `ProjectDirs` struct directly from a `PathBuf` value. /// The argument is used verbatim and is not adapted to operating system standards. /// /// The use of `ProjectDirs::from_path` is strongly discouraged, as its results will /// not follow operating system standards on at least two of three platforms. /// /// Use [`ProjectDirs::from`] instead. pub fn from_path(project_path: PathBuf) -> Option<ProjectDirs> { sys::project_dirs_from_path(project_path) } /// Creates a `ProjectDirs` struct from values describing the project. /// /// The returned value depends on the operating system and is either /// - `Some`, containing project directory paths based on the state of the system's paths at the time `new()` was invoked, or /// - `None`, if no valid home directory path could be retrieved from the operating system. /// /// To determine whether a system provides a valid `$HOME` path, please refer to [`BaseDirs::new`] /// /// The use of `ProjectDirs::from` (instead of `ProjectDirs::from_path`) is strongly encouraged, /// as its results will follow operating system standards on Linux, macOS and Windows. /// /// # Parameters /// /// - `qualifier` – The reverse domain name notation of the application, excluding the organization or application name itself.<br/> /// An empty string can be passed if no qualifier should be used (only affects macOS).<br/> /// Example values: `"com.example"`, `"org"`, `"uk.co"`, `"io"`, `""` /// - `organization` – The name of the organization that develops this application, or for which the application is developed.<br/> /// An empty string can be passed if no organization should be used (only affects macOS and Windows).<br/> /// Example values: `"Foo Corp"`, `"Alice and Bob Inc"`, `""` /// - `application` – The name of the application itself.<br/> /// Example values: `"Bar App"`, `"ExampleProgram"`, `"Unicorn-Programme"` /// /// [`BaseDirs::home_dir`]: struct.BaseDirs.html#method.home_dir pub fn from(qualifier: &str, organization: &str, application: &str) -> Option<ProjectDirs> { sys::project_dirs_from(qualifier, organization, application) } /// Returns the project path fragment used to compute the project's cache/config/data directories. /// The value is derived from the `ProjectDirs::from` call and is platform-dependent. pub fn project_path(&self) -> &Path { self.project_path.as_path() } /// Returns the path to the project's cache directory. /// /// |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 cache_dir(&self) -> &Path { self.cache_dir.as_path() } /// Returns the path to the project's config directory. /// /// |Platform | Value | Example | /// | ------- | ----------------------------------------------------------------------- | ------------------------------------------------------ | /// | Linux | `$XDG_CONFIG_HOME`/`_project_path_` or `$HOME`/.config/`_project_path_` | /home/alice/.config/barapp | /// | macOS | `$HOME`/Library/Preferences/`_project_path_` | /Users/Alice/Library/Preferences/com.Foo-Corp.Bar-App | /// | Windows | `{FOLDERID_RoamingAppData}`\\`_project_path_`\\config | C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\config | pub fn config_dir(&self) -> &Path { self.config_dir.as_path() } /// Returns the path to the project's data directory. /// /// |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_RoamingAppData}`\\`_project_path_`\\data | C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\data | pub fn data_dir(&self) -> &Path { self.data_dir.as_path() } /// Returns the path to the project's local data directory. /// /// |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 | pub fn data_local_dir(&self) -> &Path { self.data_local_dir.as_path() } /// Returns the path to the project's runtime directory. /// /// |Platform | Value | Example | /// | ------- | ----------------------------------- | --------------------- | /// | Linux | `$XDG_RUNTIME_DIR`/`_project_path_` | /run/user/1001/barapp | /// | macOS | – | – | /// | Windows | – | – | pub fn runtime_dir(&self) -> Option<&Path> { self.runtime_dir.as_ref().map(|p| p.as_path()) } } #[cfg(test)] mod tests { #[test] fn test_base_dirs() { println!("BaseDirs::new())\n{:?}", crate::BaseDirs::new()); } #[test] fn test_user_dirs() { println!("UserDirs::new())\n{:?}", crate::UserDirs::new()); } #[test] fn test_project_dirs() { let proj_dirs = crate::ProjectDirs::from("qux", "FooCorp", "BarApp"); println!("ProjectDirs::from(\"qux\", \"FooCorp\", \"BarApp\")\n{:?}", proj_dirs); let proj_dirs = crate::ProjectDirs::from("qux.zoo", "Foo Corp", "Bar-App"); println!("ProjectDirs::from(\"qux.zoo\", \"Foo Corp\", \"Bar-App\")\n{:?}", proj_dirs); let proj_dirs = crate::ProjectDirs::from("com", "Foo Corp.", "Bar App"); println!("ProjectDirs::from(\"com\", \"Foo Corp.\", \"Bar App\")\n{:?}", proj_dirs); } }