Crate directories

source ·
Expand description

The directories crate is

  • a tiny library with a minimal API (3 structs, 4 factory functions, getters)
  • that provides the platform-specific, user-accessible locations
  • for finding and storing configuration, cache and other data
  • on Linux, Redox, Windows (≥ Vista) and macOS.

The library provides the location of these directories by leveraging the mechanisms defined by

Structs

  • BaseDirs provides paths of user-invisible standard directories, following the conventions of the operating system the library is running on.
  • ProjectDirs computes the location of cache, config or data directories for a specific application, which are derived from the standard directories and the name of the project/organization.
  • UserDirs provides paths of user-facing standard directories, following the conventions of the operating system the library is running on.