Directories.Net 1.0.0

Directories.Net

Introduction

• a tiny library (12kB) with a minimal API
• that provides the platform-specific, user-accessible locations
• for retrieving and storing configuration, cache and other data
• on Linux, Windows (≥ 7), macOS and BSD

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

• the XDG base directory and the XDG user directory specifications on Linux
• the Known Folder API on Windows
• the Standard Directories guidelines on macOS

Platforms

This library is written for .NET, and runs on .NET 6.0 and later.

A version of this library implemented in Rust is provided by directories-rs.

This version is directly based on the Java version.

Usage

Dependency

Add the library as a dependency to your project:

<ItemGroup>
  <PackageReference Include="Directories.Net" Version="1.0.0" />
</ItemGroup>

Example

Library run by user Alice:

using Directories.Net;

ProjectDirectories myProjDirs = ProjectDirectories.From("com", "Foo Corp", "Bar App");
myProjDirs.configDir;
// Lin: /home/alice/.config/barapp
// Mac: /Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App
// Win: C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\config

BaseDirectories baseDirs = new BaseDirectories();
baseDirs.executableDir;
// Lin: /home/alice/.local/bin
// Mac: null
// Win: null

UserDirectories userDirs = new UserDirectories();
userDirs.audioDir;
// Lin: /home/alice/Music
// Mac: /Users/Alice/Music
// Win: C:\Users\Alice\Music

Design Goals

• The directories library is designed to provide an accurate snapshot of the system's state at the point of invocation of new BaseDirectories(), new UserDirectories() or ProjectDirectories.From().
• This library does not create directories or check for their existence. The library only provides information on what the path to a certain directory should be. How this information is used is a decision that developers need to make based on the requirements of each individual application.
• This library is intentionally focused on providing information on user-writable directories only. There is no discernible benefit in returning a path that points to a user-level, writable directory on one operating system, but a system-level, read-only directory on another, that would outweigh the confusion and unexpected failures such an approach would cause.
  • ExecutableDir is specified to provide the path to a user-writable directory for binaries.<br/> As such a directory only commonly exists on Linux, it returns null on macOS and Windows.
  • FontDir is specified to provide the path to a user-writable directory for fonts.<br/> As such a directory only exists on Linux and macOS, it returns null Windows.
  • RuntimeDir is specified to provide the path to a directory for non-essential runtime data. It is required that this directory is created when the user logs in, is only accessible by the user itself, is deleted when the user logs out, and supports all filesystem features of the operating system.<br/> As such a directory only commonly exists on Linux, it returns null on macOS and Windows.

Features

BaseDirectories

The intended use-case for BaseDirectories is to query the paths of user-invisible standard directories that have been defined according to the conventions of the operating system the library is running on.

If you want to compute the location of cache, config or data folders for your own application or project, use ProjectDirectories instead.

UserDirectories

The intended use-case for UserDirectories is to query the paths of user-facing standard directories that have been defined according to the conventions of the operating system the library is running on.

ProjectDirectories

The intended use-case for ProjectDirectories is to compute the location of cache, config or data folders for your own application or project, which are derived from the standard directories.

The specific value of <project_path> is computed by the

ProjectDirectories.From(string qualifier,
                        string organization,
                        string application)

method and varies across operating systems. As an example, calling

ProjectDirectories.From("org"         /*qualifier*/,
                        "Baz Corp"    /*organization*/,
                        "Foo Bar-App" /*application*/)

results in the following values:

The ProjectDirectories.FromPath method allows the creation of ProjectDirectories instances directly from a project path. This argument is used verbatim and is not adapted to operating system standards. The use of ProjectDirectories.FromPath is strongly discouraged, as its results will not follow operating system standards on at least two of three platforms. Directories