xdgdir 0.8.0

Resolves paths according to the XDG Base Directory Specification
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

# xdgdir

`xdgdir` helps you to resolves paths according to the
[XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/latest/).

- **Zero I/O**: The library performs no filesystem operations. It is a pure path
  resolver, making it fast, predictable, and suitable for any context, including
  async runtimes.
- **Spec Compliant**: Correctly handles environment variables, empty variables,
  and default fallbacks as defined by the spec.
- **Simple API**: Provides a minimal, ergonomic API for the most common use
  cases.

## Getting started

Add `xdgdir` to your project's dependencies:

```sh
cargo add xdgdir
```

## Usage

To get the set of directories for your specific application, use
`BaseDir::new()`.

```rust
use xdgdir::BaseDir;

fn main() {
    let dirs = BaseDir::new("my-app").unwrap();

    println!("Config file should be in: {}", dirs.config.display());
    // -> /home/user/.config/my-app
    println!("Data files should be in: {}", dirs.data.display());
    // -> /home/user/.local/share/my-app
}
```

To get the raw, non-application-specific base directories, use
`BaseDir::global()`.

```rust
use xdgdir::BaseDir;

fn main() {
    let global_dirs = BaseDir::global().unwrap();

    println!("Default user config dir: {}", global_dirs.config.display());
    // -> /home/user/.config
    println!("User executables dir: {}", global_dirs.bin.display());
    // -> /home/user/.local/bin
}
```

## License

This project is licensed under the MIT License.