https://github.com/lunacookies/etcetera

An unopinionated Rust library for locating configuration, data and cache directories across platforms
https://github.com/lunacookies/etcetera

Last synced: 2 days ago
JSON representation

An unopinionated Rust library for locating configuration, data and cache directories across platforms

• Host: GitHub
• URL: https://github.com/lunacookies/etcetera
• Owner: lunacookies
• License: apache-2.0
• Created: 2020-05-15T10:44:14.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-28T10:43:14.000Z (5 months ago)
• Last Synced: 2024-12-24T03:15:02.380Z (2 days ago)
• Language: Rust
• Size: 68.4 KB
• Stars: 83
• Watchers: 3
• Forks: 9
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
[![crates.io version](https://img.shields.io/crates/v/etcetera?style=for-the-badge)](https://crates.io/crates/etcetera)

[![crates.io revdeps](https://img.shields.io/crates/d/etcetera?style=for-the-badge)](https://crates.io/crates/etcetera/reverse_dependencies)

[![documentation](https://img.shields.io/docsrs/etcetera?style=for-the-badge)](https://docs.rs/etcetera)

![license](https://img.shields.io/crates/l/etcetera?style=for-the-badge)

# Etcetera

This is a Rust library that allows you to determine the locations of configuration, data, cache & other files for your application.

Existing Rust libraries generally do not give you a choice in terms of which standards/conventions they follow.

Etcetera, on the other hand, gives you the choice.

MSRV: 1.54.0

## Conventions

Etcetera supports the following conventions:

- the [XDG base directory](https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html)

- Apple's [Standard Directories](https://developer.apple.com/library/content/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html)

- Window's [Known Folder Locations](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid)

- the "Unix Single-folder Convention" i.e. everything in `~/.myapp`

## Strategies

Etcetera has 2 modes of operation: `BaseStrategy` & `AppStrategy`:

- With `BaseStrategy`, you just get the location of the respective directory. For eg. for `config_dir()`:

  - XDG: `~/.config`

  - Apple: `~/Library/Preferences`

  - Windows: `~\AppData\Roaming`

- With `AppStrategy`, you provide additional information to get the location of your app directory.

  For eg. if you provide the following details: `{ top_level_domain: "org", author: "Acme Corp", app_name: "Frobnicator Plus" }`, you'll get:

  - XDG: `~/.config/frobnicator-plus`

  - Unix: `~/.frobnicator-plus`

  - Apple: `~/Library/Preferences/org.acmecorp.FrobnicatorPlus`

  - Windows: `~\AppData\Roaming\Acme Corp\Frobnicator Plus`

Note: the location of the home (~) is determined by the [`home`](https://docs.rs/home/0.5.4/home/fn.home_dir.html) crate.

### Convenience functions

Etcetera also provides convenience functions for selecting the appropriate strategy on each platform:

- `base_strategy::choose_base_strategy` & `app_strategy::choose_app_strategy`: Uses `Windows` on Windows & `XDG` everywhere else.

  This is used by most CLI tools & some GUI tools on each platform.

- `base_strategy::choose_native_strategy` & `app_strategy::choose_native_strategy`: Uses `Windows` on Windows, `Apple` on macOS/iOS, & `XDG` everywhere else.

  This is used by most GUI applications on each platform.

##

See the ![documentation](https://docs.rs/etcetera) for examples.