Specs

argv() :: [String.t()]

Выводит аргументы командной строки.

Возвращает список аргументов командной строки, переданных программе.

Specs

argv([String.t()]) :: :ok

Изменяет аргументы командной строки.

Изменяет список аргументов командной строки. Используйте с осторожностью, так как это уничтожает любые предыдущие данные argv.

Specs

at_exit((non_neg_integer() -> any())) :: :ok

Регистрирует функцию обработчика завершения программы.

Регистрирует функцию, которая будет вызвана в конце выполнения программы. Полезно для вызова хука в режиме «скрипт».

Обработчик всегда выполняется в другом процессе, чем тот, в котором он был зарегистрирован. Вследствие этого любые ресурсы, управляемые вызывающим процессом (таблицы ETS, открытые файлы и т. д.), не будут доступны к моменту вызова функции обработчика.

Функция должна принимать код состояния завершения в качестве аргумента.

Specs

build_info() :: %{
  build: String.t(),
  date: String.t(),
  revision: String.t(),
  version: String.t(),
  otp_release: String.t()
}

Информация о сборке Elixir.

Возвращает карту с версией Elixir, релизом Erlang/OTP, с которым она была скомпилирована, коротким хэшем Git и датой и временем сборки.

Каждое значение в карте — строка, а именно:

• :build - версия Elixir, короткий хэш Git и релиз Erlang/OTP, с которым она была скомпилирована
• :date - строковое представление даты и времени ISO8601, когда она была построена
• :opt_release - релиз OTP, с которым она была скомпилирована
• :revision - короткий хэш Git. Если Git не был доступен во время сборки, он устанавливается в ""
• :version - версия Elixir

Не следует полагаться на конкретные форматы, возвращаемые каждым из этих полей. Вместо этого следует использовать специализированные функции, такие как version/0 для получения версии Elixir и otp_release/0 для получения релиза Erlang/OTP.

Примеры

iex> System.build_info()
%{
  build: "1.9.0-dev (772a00a0c) (compiled with Erlang/OTP 21)",
  date: "2018-12-24T01:09:21Z",
  otp_release: "21",
  revision: "772a00a0c",
  version: "1.9.0-dev"
}

Specs

cmd(binary(), [binary()], keyword()) ::
  {Collectable.t(), exit_status :: non_neg_integer()}

Выполняет заданную command с args.

command ожидается как исполняемый файл, доступный в PATH, если не указан абсолютный путь.

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

• переменные среды не будут интерполированы
• расширение символов-подстановок не произойдёт (если Path.wildcard/2 не используется явно)
• аргументы не нужно экранировать или заключать в кавычки для безопасности оболочки

Эта функция возвращает кортеж, содержащий собранный результат и код завершения команды.

Внутренне эта функция использует Port для взаимодействия с внешним миром. Однако, если вы планируете запустить долгоживущую программу, порты гарантируют, что устройства stdin/stdout будут закрыты, но не автоматически завершат программу. Документация модуля Port описывает эту проблему и возможные решения в разделе «Процессы-зомби».

Примеры

iex> System.cmd("echo", ["hello"])
{"hello\n", 0}

iex> System.cmd("echo", ["hello"], env: [{"MIX_ENV", "test"}])
{"hello\n", 0}

iex> System.cmd("echo", ["hello"], into: IO.stream(:stdio, :line))
hello
{%IO.Stream{}, 0}

Параметры

• :into - вставляет результат в заданный собираемый объект, по умолчанию ""
• :cd - каталог для выполнения команды
• :env - перечисляемый список кортежей, содержащих имя-значение переменных среды в виде двоичных данных
• :arg0 - устанавливает аргумент команды arg0
• :stderr_to_stdout - перенаправляет stderr в stdout, когда true
• :parallelism - при true, VM будет планировать задачи порта для повышения параллелизма в системе. Если установлено false, VM будет пытаться выполнить команды немедленно, улучшая время отклика в ущерб параллелизму. Значение по умолчанию может быть установлено при запуске системы, передав аргумент «+spp» в --erl.

Причины ошибок

Если предоставлены некорректные аргументы, ArgumentError генерируется System.cmd/3. System.cmd/3 также ожидает строгий набор параметров и будет генерировать ошибку, если предоставлены неизвестные или некорректные параметры.

Кроме того, System.cmd/3 может завершиться с одной из POSIX-ошибок, описанных ниже:

• :system_limit - все доступные порты в эмуляторе Erlang заняты

• :enomem - не хватает памяти для создания порта

• :eagain - больше нет доступных процессов операционной системы

• :enametoolong - внешняя команда слишком длинная

• :emfile - больше нет доступных дескрипторов файлов (для процесса операционной системы, в котором работает эмулятор Erlang)

• :enfile - таблица файлов заполнена (для всей операционной системы)

• :eacces - команда не указывает на исполняемый файл

• :enoent - команда не указывает на существующий файл

Команды оболочки

Если вы хотите выполнить надёжную команду в оболочке с каналами, перенаправлением и т. д., пожалуйста, обратитесь к :os.cmd/1.

Specs

compiled_endianness() :: :little | :big

Возвращает порядок байтов, с которым была скомпилирована система.

Specs

convert_time_unit(integer(), time_unit() | :native, time_unit() | :native) ::
  integer()

Преобразует time из временной единицы from_unit в временную единицу to_unit.

Результат округляется с помощью функции floor.

convert_time_unit/3 принимает дополнительную временную единицу (кроме тех, что в типе time_unit/0), называемую :native. :native — единица измерения времени, используемая системой выполнения Erlang. Она определяется при запуске среды выполнения и остается неизменной до ее остановки, но может отличаться при каждом последующем запуске на одном и том же компьютере. По этой причине вы должны использовать эту функцию для преобразования временных единиц :native в предсказуемую единицу перед отображением их пользователю.

Чтобы определить, сколько секунд представляет собой единица :native в вашей текущей среде выполнения, вы можете вызвать эту функцию для преобразования 1 секунды в единицу времени :native: System.convert_time_unit(1, :second, :native).

Specs

cwd() :: String.t() | nil

Текущий рабочий каталог.

Возвращает текущий рабочий каталог или nil если таковой не доступен.

Specs

cwd!() :: String.t()

Текущий рабочий каталог, исключение при ошибке.

Возвращает текущий рабочий каталог или вызывает RuntimeError.

Specs

delete_env(String.t()) :: :ok

Удаляет переменную среды.

Удаляет переменную varname из среды.

Specs

endianness() :: :little | :big

Возвращает порядок байтов.

Specs

fetch_env(String.t()) :: {:ok, String.t()} | :error

Возвращает значение заданной переменной среды или :error если она не найдена.

Если переменная среды varname установлена, то возвращается {:ok, value}, где value — строка. Если varname не установлена, возвращается :error.

Примеры

iex> System.fetch_env("PORT")
{:ok, "4000"}

iex> System.fetch_env("NOT_SET")
:error

Specs

fetch_env!(String.t()) :: String.t()

Возвращает значение заданной переменной среды или вызывает исключение, если она не найдена.

То же, что и get_env/1, но вызывает исключение вместо возвращения nil при отсутствии переменной.

Примеры

iex> System.fetch_env!("PORT")
"4000"

iex> System.fetch_env!("NOT_SET")
** (ArgumentError) could not fetch environment variable "NOT_SET" because it is not set

Specs

find_executable(binary()) :: binary() | nil

Находит исполняемый файл в системе.

Эта функция ищет исполняемую программу по заданному имени, используя переменную среды PATH в Unix и Windows. Она также учитывает правильное расширение исполняемого файла для каждой операционной системы, поэтому в Windows она будет пытаться найти файлы с .com, .cmd или подобными расширениями.

Specs

get_env() :: %{optional(String.t()) => String.t()}

Возвращает все системные переменные среды.

Возвращаемое значение — карта, содержащая пары имя-значение. Имена переменных и их значения — строки.

Характеристики

get_env(String.t(), String.t() | nil) :: String.t() | nil

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

Возвращаемое значение переменной окружения varname — строка. Если переменная окружения не задана, возвращается строка, указанная в default или nil, если она не указана.

Примеры

iex> System.get_env("PORT")
"4000"

iex> System.get_env("NOT_SET")
nil

iex> System.get_env("NOT_SET", "4001")
"4001"

Характеристики

get_pid() :: binary()

Идентификатор процесса виртуальной машины Erlang.

Возвращает идентификатор процесса текущего эмулятора Erlang в формате, наиболее часто используемом средой операционной системы.

Для получения дополнительной информации см. :os.getpid/0.

Характеристики

halt(non_neg_integer() | binary() | :abort) :: no_return()

Немедленно завершает работу системы выполнения Erlang.

Завершает работу системы выполнения Erlang без правильного завершения работы приложений и портов. См. stop/1 для аккуратного завершения работы системы.

status должно быть целым неотрицательным числом, атомом :abort или двоичным значением.

• Если целое число, система выполнения завершается со значением целого числа, которое возвращается операционной системе.

• Если :abort, система выполнения прерывается, создавая дамп ядра, если это включено в операционной системе.

• Если строка, создается дамп сбоя Erlang со статусом в качестве слогана, после чего система выполнения завершается со статусом 1.

Обратите внимание, что во многих платформах операционная система поддерживает только коды состояния 0-255.

Для получения дополнительной информации см. :erlang.halt/1.

Примеры

System.halt(0)
System.halt(1)
System.halt(:abort)

Характеристики

monotonic_time() :: integer()

Возвращает текущее монотонное время в :native единицах времени.

Это время монотонно возрастает и начинается в неопределённую точку времени.

Встраивается компилятором.

Характеристики

monotonic_time(time_unit()) :: integer()

Возвращает текущее монотонное время в заданной единице времени.

Это время монотонно возрастает и начинается в неопределённую точку времени.

Характеристики

no_halt() :: boolean()

Проверяет, будет ли система завершена после обработки ARGV.

Характеристики

no_halt(boolean()) :: :ok

Помечает, должна ли система завершиться после обработки ARGV.

Характеристики

os_time() :: integer()

Возвращает текущее время операционной системы (ОС).

Результат возвращается в :native единицах времени.

Это время может быть скорректировано вперёд или назад без ограничений и не является монотонным.

Встраивается компилятором.

Характеристики

os_time(time_unit()) :: integer()

Возвращает текущее время операционной системы (ОС) в заданной единице времени unit.

Это время может быть скорректировано вперёд или назад без ограничений и не является монотонным.

Характеристики

otp_release() :: String.t()

Возвращает номер выпуска Erlang/OTP.

Характеристики

pid() :: String.t()

Возвращает идентификатор процесса операционной системы для текущего экземпляра системы выполнения Erlang.

Возвращает строку, содержащую (обычно) числовой идентификатор процесса. В UNIX это обычно значение, возвращаемое вызовом системы getpid(). В Windows используется идентификатор процесса, возвращаемый вызовом системы GetCurrentProcessId().

Примеры

System.pid()

Характеристики

put_env(Enumerable.t()) :: :ok

Устанавливает несколько переменных окружения.

Устанавливает новое значение для каждой переменной окружения, соответствующей каждой паре {key, value} в enum.

Характеристики

put_env(binary(), binary()) :: :ok

Устанавливает значение переменной окружения.

Устанавливает новое value для переменной окружения varname.

Характеристики

restart() :: :ok

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

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

Примеры

System.restart()

Характеристики

schedulers() :: pos_integer()

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

Характеристики

schedulers_online() :: pos_integer()

Возвращает количество активных планировщиков в виртуальной машине.

Устаревший механизм получения последнего стека исключений.

Доступ к стеку исключений вне rescue/catch устарел. Если вы хотите поддерживать только Elixir v1.7+, вы должны получить доступ к __STACKTRACE__/0 внутри rescue/catch. Если вы хотите поддерживать более ранние версии Elixir, переместите System.stacktrace/0 внутри rescue/catch.

Обратите внимание, что виртуальная машина Erlang (и, следовательно, эта функция) не возвращает текущий стек исключений, а скорее стек исключений последнего исключения. Чтобы получить стек исключений текущего процесса, используйте Process.info(self(), :current_stacktrace) вместо этого.

Характеристики

stop(non_neg_integer() | binary()) :: no_return()

Аккуратно останавливает систему выполнения Erlang.

Все приложения закрываются плавно, весь код выгружается, и все порты закрываются до завершения работы системы с помощью вызова halt/1.

status должно быть целое неотрицательное значение, возвращаемое системой выполнения операционной системе.

Обратите внимание, что во многих платформах операционная система поддерживает только коды состояния 0-255.

Примеры

System.stop(0)
System.stop(1)

Характеристики

system_time() :: integer()

Возвращает текущее системное время в :native единицах времени.

Это представление виртуальной машины os_time/0. Они могут не совпадать в случае перестроек времени, хотя виртуальная машина работает над их выравниванием. Это время не монотонно.

Встраивается компилятором.

Характеристики

system_time(time_unit()) :: integer()

Возвращает текущее системное время в заданной единице времени.

Это представление виртуальной машины os_time/0. Они могут не совпадать в случае перестроек времени, хотя виртуальная машина работает над их выравниванием. Это время не монотонно.

Характеристики

time_offset() :: integer()

Возвращает текущее смещение времени между монотонным временем виртуальной машины Erlang и системным временем виртуальной машины Erlang.

Результат возвращается в :native единицах времени.

См. time_offset/1 для получения дополнительной информации.

Встраивается компилятором.

Характеристики

time_offset(time_unit()) :: integer()

Возвращает текущее смещение времени между монотонным временем виртуальной машины Erlang и системным временем виртуальной машины Erlang.

Результат возвращается в заданной единице времени unit. Полученное смещение, добавленное к монотонному времени Erlang (например, полученному с помощью monotonic_time/1), даёт системное время Erlang, соответствующее этому монотонному времени.

Характеристики

tmp_dir() :: String.t() | nil

Директория временных файлов с возможностью записи.

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

1. директория, указанная переменной окружения TMPDIR
2. директория, указанная переменной окружения TEMP
3. директория, указанная переменной окружения TMP
4. C:\TMP в Windows или /tmp в Unix
5. в крайнем случае, текущая рабочая директория

Возвращает nil если ни одна из вышеперечисленных директорий не является доступной для записи.

Характеристики

tmp_dir!() :: String.t()

Запись каталога временных файлов, исключение при ошибке.

То же, что и tmp_dir/0, но вызывает RuntimeError вместо возвращения nil при отсутствии каталога временных файлов.

Характеристики

unique_integer([:positive | :monotonic]) :: integer()

Генерирует и возвращает целое число, уникальное в текущей инстанции выполнения.

«Уникальное» означает, что эта функция, вызываемая со списком тех же modifiers, никогда не вернёт одно и то же целое число более одного раза в текущей инстанции выполнения.

Если modifiers является [], то возвращается уникальное целое число (может быть положительным или отрицательным). Другие модификаторы могут быть переданы для изменения свойств возвращаемого целого числа:

• :positive - возвращаемое целое число гарантированно положительное.
• :monotonic - возвращаемое целое число монотонно возрастает. Это означает, что в одной и той же инстанции выполнения (но даже в разных процессах) целые числа, возвращаемые с модификатором :monotonic, всегда будут строго меньше целых чисел, возвращаемых последующими вызовами с модификатором :monotonic.

Все вышеперечисленные модификаторы могут быть объединены; повторяющиеся модификаторы в modifiers будут проигнорированы.

Встраивается компилятором.

Характеристики

user_home() :: String.t() | nil

Директория пользователя.

Возвращает домашнюю директорию пользователя (независимо от платформы).

Характеристики

user_home!() :: String.t()

Директория пользователя, исключение при ошибке.

То же, что и user_home/0, но вызывает RuntimeError вместо возвращения nil при отсутствии домашней директории пользователя.

Характеристики

version() :: String.t()

Информация о версии Elixir.

Возвращает версию Elixir в виде бинарного значения.