std/appdirs

Этот модуль реализует вспомогательные функции для определения специальных каталогов, используемых приложениями.

Импорты

osappdirs, paths, envvars

Процедуры

proc getCacheDir(): Path {.inline, ...raises: [], tags: [ReadEnvEffect],
                           forbids: [].}

Возвращает каталог кэша текущего пользователя для приложений.

Используются следующие переменные среды:

• В Windows: getEnv("LOCALAPPDATA")
• В macOS: getEnv("XDG_CACHE_HOME", getEnv("HOME") / "Library/Caches")
• В других системах: getEnv("XDG_CACHE_HOME", getEnv("HOME") / ".cache")

См. также:

• процедура getHomeDir
• процедура getTempDir
• процедура getConfigDir

Source Edit

proc getCacheDir(app: Path): Path {.inline, ...raises: [], tags: [ReadEnvEffect],
                                    forbids: [].}

Возвращает каталог кэша для приложения app.

• В Windows: getCacheDir() / app / "cache"
• В других системах: getCacheDir() / app

Source Edit

proc getConfigDir(): Path {.inline, ...tags: [ReadEnvEffect, ReadIOEffect],
                            raises: [], forbids: [].}

Возвращает каталог конфигурации текущего пользователя для приложений.

В системах, отличных от Windows, эта процедура соответствует спецификации XDG Base Directory. Таким образом, эта процедура возвращает значение переменной среды XDG_CONFIG_HOME, если она установлена, в противном случае возвращает стандартный каталог конфигурации ("~/.config/").

Завершающий слэш, зависящий от ОС, всегда присутствует в конце возвращаемой строки: \\ в Windows и / во всех других ОС.

См. также:

• процедура getHomeDir
• процедура getTempDir

Source Edit

proc getDataDir(): Path {.inline, ...tags: [ReadEnvEffect, ReadIOEffect],
                          raises: [], forbids: [].}

Возвращает каталог данных текущего пользователя для приложений.

В системах, отличных от Windows, эта процедура соответствует спецификации XDG Base Directory. Таким образом, эта процедура возвращает значение переменной среды XDG_DATA_HOME, если она установлена, в противном случае возвращает стандартный каталог данных ("~/.local/share" или "~/Library/Application Support" в macOS).

См. также:

• процедура getHomeDir
• процедура getConfigDir
• процедура getTempDir
• процедура paths: expandTilde
• процедура paths: getCurrentDir
• setCurrentDir

Source Edit

proc getHomeDir(): Path {.inline, ...tags: [ReadEnvEffect, ReadIOEffect],
                          raises: [], forbids: [].}

Возвращает домашний каталог текущего пользователя.

Эта процедура обернута процедурой paths: expandTilde для удобства обработки путей, полученных из файлов конфигурации пользователя.

См. также:

• процедура getConfigDir
• процедура getTempDir

Source Edit

proc getTempDir(): Path {.inline, ...tags: [ReadEnvEffect, ReadIOEffect],
                          raises: [], forbids: [].}

Возвращает временный каталог текущего пользователя для хранения временных файлов приложениями.

В Windows вызывается GetTempPath. В системах на основе Posix она проверяет переменные среды TMPDIR, TEMP, TMP и TEMPDIR в определенном порядке. Во всех платформах /tmp возвращается, если процедура завершилась неудачно.

Вы можете переопределить эту реализацию, добавив -d:tempDir=mytempname в вызов компилятора.

Примечание: Эта процедура не проверяет, существует ли возвращённый путь.

См. также:

• процедура getHomeDir
• процедура getConfigDir

Source Edit