dir_spec 0.5.0

A cross-platform Rust library for resolving XDG and platform-specific directories with proper fallbacks.
Documentation 
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

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog], and this project adheres to [Break Versioning].

## [0.5.0] - 2025-08-29

### Changed

* **BREAKING**: Removed `Dir` struct and moved all methods to module-level functions
* **BREAKING**: All directory resolution functions are now called directly (e.g., `config_home()` instead of
  `Dir::config_home()`)
* Updated crate-level documentation to reflect new function-based API
* Updated all examples in documentation to use new function calls

### Removed

* **BREAKING**: Removed `Dir` struct entirely

## [0.4.0] - 2025-08-28

### Changed

* Refactored internal architecture to use platform-specific modules (`linux.rs`, `macos.rs`, `windows.rs`) for improved
  code organization and maintainability
* Extracted XDG Base Directory Specification logic into dedicated `xdg` module with reusable helper functions
* Replaced inline conditional compilation scattered throughout `lib.rs` with clean module delegation pattern

## [0.3.0] - 2025-08-24

### Added

* `config_local()` - Returns user's local (non-roaming) config directory. On Windows uses `%LOCALAPPDATA%`, identical
  to `config_home()` on other platforms
* `data_local()` - Returns user's local (non-roaming) data directory. On Windows uses `%LOCALAPPDATA%`, identical to
  `data_home()` on other platforms
* `fonts()` - Returns user's fonts directory
  (`~/.local/share/fonts` on Linux, `~/Library/Fonts` on macOS, `None` on Windows)
* `preferences()` - Returns user's preferences directory. On macOS returns `~/Library/Preferences` for .plist files,
  identical to `config_home()` on other platforms

## [0.2.0] - 2025-08-10

### Changed

* **BREAKING**: All methods now return `Option<PathBuf>` instead of `Result<PathBuf>`
* **BREAKING**: `home()` method now uses `std::env::home_dir()` directly (was previously deprecated, now undeprecated)
* **BREAKING**: `runtime()` method on Linux now uses `$TMPDIR` then `/tmp` fallback instead of `/run/user/{uid}`
* Simplified error handling by removing `eyre` dependency from public API
* Updated documentation and examples to use Option pattern matching

### Removed

* **BREAKING**: Removed `eyre` dependency from public API
* **BREAKING**: Removed `libc` dependency entirely
* **BREAKING**: Removed all deprecated `*_dir()` method variants:
  * `desktop_dir()` (use `desktop()`)
  * `documents_dir()` (use `documents()`)
  * `download_dir()` (use `downloads()`)
  * `music_dir()` (use `music()`)
  * `pictures_dir()` (use `pictures()`)
  * `publicshare_dir()` (use `publicshare()`)
  * `runtime_dir()` (use `runtime()`)
  * `templates_dir()` (use `templates()`)
  * `videos_dir()` (use `videos()`)

### Fixed

* Eliminated potential panic in `home()` method by properly handling `None` case from `std::env::home_dir()`
* Removed unsafe code by eliminating libc dependency

## [0.1.0] - 2025-08-08

### Added

* New, cleaner directory resolution methods without the `_dir` suffix
  (e.g., `Dir::desktop()` replaces `Dir::desktop_dir()`).
* Comprehensive test coverage for XDG absolute/relative path behavior and platform defaults.

### Changed

* Refactored implementation to remove duplicated logic by consolidating directory resolvers into a single `Dir`
  implementation with internal helpers.

### Deprecated

* All `*_dir()` methods are now deprecated in favor of their shorter equivalents (e.g., `Dir::desktop()`).

### Fixed

* Now correctly ignores non-absolute paths in `XDG_*` environment variables, as required by the XDG Base Directory
  Specification.

## 0.0.1 - 2025-08-08

* Initial release

[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
[Break Versioning]: https://www.taoensso.com/break-versioning

<!-- versions -->

[Unreleased]: https://github.com/aaronmallen/dir_spec/compare/0.5.0...HEAD
[0.5.0]: https://github.com/aaronmallen/dir_spec/compare/0.4.0...0.5.0
[0.4.0]: https://github.com/aaronmallen/dir_spec/compare/0.3.0...0.4.0
[0.3.0]: https://github.com/aaronmallen/dir_spec/compare/0.2.0...0.3.0
[0.2.0]: https://github.com/aaronmallen/dir_spec/compare/0.1.0...0.2.0
[0.1.0]: https://github.com/aaronmallen/dir_spec/compare/0.0.1...0.1.0