lunacookies / etcetera

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

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
• Apple's Standard Directories
• Window's Known Folder Locations
• 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 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 for examples.

etcetera's Issues

Change XDG defaults on Windows to use Windows spec

Ref helix-editor/helix#6747

When the environment variables aren't set, they should use the Windows location instead. This is how most XDG implementations handle fallback on Windows, such as glib.

Notification of inclusion into Fedora repositories

Hi there,

I'm just opening this issue to notify you that I am currently working on including this into the Fedora repositories under the name rust-etcetera. If you have any comments, objections or queries regarding this process, then please reply here or contact me directly by emailing [email protected].

Thanks for making something awesome!

Bugzilla reference: https://bugzilla.redhat.com/show_bug.cgi?id=2240793

[Feature Request]Dir for log

Log dir for each platform

Linux	macOS	Windows
state_dir()	$HOME/Library/Logs/app_bundle_id	data_dir()

Ref

• Linux
• macOS
• Windows

On windows use XDG base directory if set

On windows, I set XDG directories and I want to use this location instead of ~\AppData\Roaming. My home directory is full and I can't change it so I set my XDG directories to a different drive that I clone from git and update from git. Can you add a strategy to use XDG directories if set?

Allow arbitrary bundle_id

Hi there! Would it be possible to set the bundle_id directly, so as to not force the ‘com.foo.Bar’ format?
I’m happy to provide a PR.