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

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

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

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

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

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

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

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

Регистрирует функцию, которая будет вызвана в конце скрипта Elixir. Скрипт обычно запускается через командную строку с помощью исполняемых файлов elixir и mix.

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

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

Если VM завершает программу программно, через System.stop/1, System.halt/1 или сигналы выхода, вызовы at_exit/1 не гарантируются к выполнению.

@spec 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
• :otp_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"
}

@spec compiled_endianness() :: :little | :big

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

@spec 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 в текущей среде выполнения, можно вызвать эту функцию, преобразуя 1 секунду в единицу измерения :native: System.convert_time_unit(1, :second, :native).

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

Текущая рабочая директория.

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

@spec cwd!() :: String.t()

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

Возвращает текущую рабочую директорию или вызывает исключение RuntimeError.

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

Удаляет переменную окружения.

Удаляет переменную varname из окружения.

@spec endianness() :: :little | :big

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

@spec 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

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

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

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

Примеры

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

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

@spec find_executable(binary()) :: binary() | nil

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

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

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

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

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

@spec get_env(String.t(), String.t()) :: String.t()

@spec get_env(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"

@spec get_pid() :: binary()

Идентификатор процесса Erlang VM.

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

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

@spec 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)

@spec monotonic_time() :: integer()

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

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

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

@spec monotonic_time(time_unit()) :: integer()

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

Это время монотонно увеличивается и начинается в неопределённый момент времени.

@spec no_halt() :: boolean()

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

@spec no_halt(boolean()) :: :ok

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

@spec os_time() :: integer()

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

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

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

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

@spec os_time(time_unit() | :native) :: integer()

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

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

@spec otp_release() :: String.t()

Возвращает номер версии Erlang/OTP.

@spec pid() :: String.t()

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

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

Примеры

System.pid()

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

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

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

В целом, это удобная обертка вокруг put_env/2 и delete_env/2 с поддержкой различных форматов ключей и значений.

@spec put_env(binary(), binary()) :: :ok

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

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

@spec restart() :: :ok

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

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

Примеры

System.restart()

@spec schedulers() :: pos_integer()

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

@spec schedulers_online() :: pos_integer()

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

@spec shell(
  binary(),
  keyword()
) :: {Collectable.t(), exit_status :: non_neg_integer()}

Выполняет данную command в командной оболочке ОС.

Использует sh для систем Unix-подобных и cmd для Windows.

Внимание

Используйте эту функцию с осторожностью. В частности, никогда не передавайте недоверенные данные пользователя в эту функцию, так как пользователь сможет выполнить "атаки с подменой команд", выполнив любой код напрямую на компьютере. В целом, предпочтительнее использовать cmd/3 вместо этой функции.

Примеры

iex> System.shell("echo hello")
{"hello\n", 0}

Если вы хотите передать вывод в стандартный ввод по мере его поступления:

iex> System.shell("echo hello", into: IO.stream())
hello
{%IO.Stream{}, 0}

Параметры

Она принимает те же параметры, что и cmd/3 (кроме arg0). Она также принимает следующие эксклюзивные параметры:

• :close_stdin (с версии v1.14.1) — если ввод stdin должен быть закрыт в системах Unix, заставляя любую команду, ожидающую ввода stdin, немедленно завершиться. По умолчанию false.

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

Он всегда возвращает пустой список.

@spec stop(non_neg_integer() | binary()) :: :ok

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

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

status должно быть неотрицательным целым числом или бинарной строкой.

• Если целое число, система выполнения завершается с целым значением, которое возвращается операционной системе. На многих платформах операционная система поддерживает только коды статуса 0-255.

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

Обратите внимание, что эта функция асинхронна, и текущий процесс продолжит выполнение после вызова этой функции. В случае, если вы хотите заблокировать текущий процесс до фактического завершения системы, вы можете вызвать Process.sleep(:infinity).

Примеры

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

@spec system_time() :: integer()

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

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

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

@spec system_time(time_unit()) :: integer()

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

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

@spec time_offset() :: integer()

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

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

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

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

@spec time_offset(time_unit()) :: integer()

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

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

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

Каталог временных файлов для записи.

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

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

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

@spec tmp_dir!() :: String.t()

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

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

@spec trap_signal(signal(), id, (-> :ok)) ::
  {:ok, id} | {:error, :already_registered} | {:error, :not_sup}
when id: term()

Перехватывает указанный signal для выполнения fun.

Избегайте установки перехватов в библиотеках

Перехват сигналов может существенно повлиять на то, как система завершается и ведет себя в рабочей среде, и поэтому крайне не рекомендуется устанавливать собственные перехваты в библиотеках. Вместо этого библиотеки должны перенаправлять пользователей на самостоятельную настройку. Единственные случаи, когда библиотеки могут устанавливать собственные перехваты, — это использование Elixir в режиме скрипта, например, в файлах .exs и через задачи Mix.

Можно указать необязательный id, который уникально идентифицирует функцию; в противном случае генерируется уникальный идентификатор. Если ранее был зарегистрирован id, эта функция возвращает кортеж ошибки. id может быть использован для удаления зарегистрированного сигнала, вызвав untrap_signal/2.

Переданная fun функция не принимает аргументов и должна возвращать :ok.

Возвращает {:ok, id} в случае успеха, {:error, :already_registered} если идентификатор уже зарегистрирован для данного сигнала или {:error, :not_sup} если перехват сигналов не поддерживается текущей ОС.

При первом перехвате сигнала будет переопределено стандартное поведение операционной системы. Если один и тот же сигнал перехватывается несколько раз, последующие функции, переданные в trap_signal, будут выполняться сначала. Другими словами, можно представить, что каждая функция добавляется в начало обработчика сигнала.

По умолчанию виртуальная машина Erlang регистрирует перехваты для трёх сигналов:

• :sigstop — вежливо завершает работу VM с stop/0
• :sigquit — останавливает VM через halt/0
• :sigusr1 — останавливает VM со статусом 1

Поэтому, если вы добавляете перехваты к указанным сигналам, стандартное поведение будет выполнено после всех пользовательских сигналов.

Примечания по реализации

Все сигналы выполняются из одного процесса. Следовательно, блокировка fun заблокирует последующие перехваты. Также невозможно добавить или удалить перехваты внутри самого перехвата.

Внутренне эта функциональность основана на :os.set_signal/2. При регистрации перехвата Elixir автоматически устанавливает его в :handle, а затем восстанавливает значение до :default после удаления всех перехватов (кроме :sigquit, :sigterm, и :sigusr1, которые всегда обрабатываются). Если вы или библиотека вызываете :os.set_signal/2 напрямую, это может отключить перехваты Elixir (или Elixir может переопределить вашу настройку).

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

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

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

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

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

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

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

@spec untrap_signal(signal(), id) :: :ok | {:error, :not_found} when id: term()

Удаляет ранее зарегистрированный signal с id.

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

Директория пользователя по умолчанию.

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

@spec user_home!() :: String.t()

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

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

@spec version() :: String.t()

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

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

@spec wait_until_booted() :: :ok

Ожидает загрузки системы.

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

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