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.
Etcetera supports the following conventions:
- the XDG base directory
- Apple's Standard Directories
- Window's Known Folder Locations
- the "Unix Single-folder Convention" i.e. everything in ~/.myapp
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 crate.
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 for examples.