#directories #path #xdg #xdg-base #dirs #basedir

etcetera

An unopinionated library for obtaining configuration, data, cache, & other directories

12 releases (7 breaking)

0.8.0 Apr 26, 2023
0.6.0 Apr 21, 2023
0.4.0 May 9, 2022
0.3.2 Nov 26, 2020
0.1.0 May 16, 2020

#8 in Configuration

Download history 33881/week @ 2023-12-22 57146/week @ 2023-12-29 78383/week @ 2024-01-05 79252/week @ 2024-01-12 85665/week @ 2024-01-19 77594/week @ 2024-01-26 82432/week @ 2024-02-02 83451/week @ 2024-02-09 85210/week @ 2024-02-16 99743/week @ 2024-02-23 104150/week @ 2024-03-01 92082/week @ 2024-03-08 97382/week @ 2024-03-15 104786/week @ 2024-03-22 115523/week @ 2024-03-29 90646/week @ 2024-04-05

425,431 downloads per month
Used in 323 crates (20 directly)

MIT/Apache

50KB
445 lines

crates.io version crates.io revdeps documentation license

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.

Conventions

Etcetera supports the following conventions:

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 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 for examples.

Dependencies

~0–10MB
~75K SLoC