std/envvars

Модуль std/envvars реализует обработку переменных окружения.

Импорты

oserrors, win_setenv, winlean

Типы

ReadEnvEffect = object of ReadIOEffect

Эффект, обозначающий чтение из переменной окружения. Source Edit

WriteEnvEffect = object of WriteIOEffect

Эффект, обозначающий запись в переменную окружения. Source Edit

Процедуры

proc delEnv(key: string) {....tags: [WriteEnvEffect], raises: [OSError],
                           forbids: [].}

Удаляет переменную окружения с именем key. Если произошла ошибка, поднимается OSError.

См. также:

• proc getEnv
• proc existsEnv
• proc putEnv
• итератор envPairs

Source Edit

proc existsEnv(key: string): bool {....tags: [ReadEnvEffect], raises: [],
                                    forbids: [].}

Проверяет, существует ли переменная окружения с именем key. Возвращает true, если она существует, и false в противном случае.

См. также:

• proc getEnv
• proc putEnv
• proc delEnv
• итератор envPairs

Пример:

assert not existsEnv("unknownEnv")

Source Edit

proc getEnv(key: string; default = ""): string {....tags: [ReadEnvEffect],
    raises: [], forbids: [].}

Возвращает значение переменной окружения с именем key.

Если переменная не существует, возвращается "". Чтобы определить, существует ли переменная или ее значение просто "", вызовите proc existsEnv(key).

См. также:

• proc existsEnv
• proc putEnv
• proc delEnv
• итератор envPairs

Пример:

assert getEnv("unknownEnv") == ""
assert getEnv("unknownEnv", "doesn't exist") == "doesn't exist"

Source Edit

proc putEnv(key, val: string) {....tags: [WriteEnvEffect], raises: [OSError],
                                forbids: [].}

Устанавливает значение переменной окружения с именем key в val. Если произошла ошибка, поднимается OSError.

См. также:

• proc getEnv
• proc existsEnv
• proc delEnv
• итератор envPairs

Source Edit

Итераторы

iterator envPairs(): tuple[key, value: string] {....tags: [ReadEnvEffect],
    raises: [], forbids: [].}

Перебирает все переменные окружения.

В первом компоненте кортежа хранится имя текущей переменной, а во втором - ее значение.

Работает в нативных бэкендах, nodejs и vm, подобно следующим API:

• proc getEnv
• proc existsEnv
• proc putEnv
• proc delEnv

Source Edit