#directory #xdg #path #base-dir

etcetera

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

14 releases (9 breaking)

0.10.0 Mar 3, 2025
0.8.0 Apr 26, 2023
0.4.0 May 9, 2022
0.3.2 Nov 26, 2020
0.1.0 May 16, 2020

#6 in Configuration

Download history 292884/week @ 2025-01-11 275747/week @ 2025-01-18 305607/week @ 2025-01-25 324447/week @ 2025-02-01 419342/week @ 2025-02-08 432890/week @ 2025-02-15 498121/week @ 2025-02-22 525647/week @ 2025-03-01 504645/week @ 2025-03-08 479950/week @ 2025-03-15 478353/week @ 2025-03-22 441478/week @ 2025-03-29 478778/week @ 2025-04-05 399805/week @ 2025-04-12 399104/week @ 2025-04-19 309995/week @ 2025-04-26

1,666,847 downloads per month
Used in 1,070 crates (64 directly)

MIT/Apache

52KB
462 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.

MSRV: 1.70.0 (You need to pin home dependency to <0.5.11, otherwise it is 1.81.0)

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.acme-corp.Frobnicator-Plus
    • 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–7.5MB
~51K SLoC