Spec-Zone.ru › Elixir 1.17

Источник Kernel.ParallelCompiler

Модуль, отвечающий за компиляцию и загрузку файлов параллельно.

Краткое описание

Типы

error()
info()
warning()

Функции

async(fun) устаревшее

Запускает задачу для параллельной компиляции.

compile(files, options \\ [])

Компилирует заданные файлы.

compile_to_path(files, path, options \\ [])

Компилирует заданные файлы и записывает получившиеся BEAM-файлы в путь.

pmap(collection, fun)

Выполняет параллельную компиляцию collection с помощью fun.

require(files, options \\ [])

Загружает заданные файлы параллельно.

Типы

error()Источник

@type error() :: {file :: Path.t(), Code.position(), message :: String.t()}

info()Источник

@type info() :: %{
  runtime_warnings: [Code.diagnostic(:warning)],
  compile_warnings: [Code.diagnostic(:warning)]
}

warning()Источник

@type warning() :: {file :: Path.t(), Code.position(), message :: String.t()}

Функции

async(fun)Источник

Эта функция устарела. Используйте `pmap/2` вместо неё.

Запускает задачу для параллельной компиляции.

compile(files, options \\ [])Источник

@spec compile(
  [Path.t()],
  keyword()
) ::
  {:ok, [atom()], [warning()] | info()}
  | {:error, [error()] | [Code.diagnostic(:error)], [warning()] | info()}

Компилирует заданные файлы.

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

Возвращает {:ok, modules, warnings} или {:error, errors, warnings} по умолчанию, но рекомендуется использовать return_diagnostics: true, чтобы она возвращала диагностические данные как карты, а также карту информации о компиляции. Карта имеет структуру:

%{
  runtime_warnings: [warning],
  compile_warnings: [warning]
}

Параметры

  • :each_file - для каждого скомпилированного файла вызывает обратный вызов, передавая файл

  • :each_long_compilation - для каждого файла, который занимает более заданного таймаута (см. опцию :long_compilation_threshold), вызывает этот обратный вызов, передавая файл в качестве аргумента

  • :each_module - для каждого скомпилированного модуля вызывает обратный вызов, передавая файл, модуль и байт-код модуля

  • :each_cycle - после компиляции заданных файлов, вызывает эту функцию, которая должна возвращать следующие значения:

    • {:compile, modules, warnings} - для продолжения компиляции с списком дополнительных модулей для компиляции
    • {:runtime, modules, warnings} - для остановки компиляции и проверки списка модулей, потому что зависимые модули изменились
  • :long_compilation_threshold - таймаут (в секундах) для проверки модулей, которые занимают слишком много времени для компиляции. Для каждого файла, который превышает порог, вызывается обратный вызов :each_long_compilation. Начиная с Elixir v1.11, во внимание берется только время, потраченное на компиляцию самого модуля, время ожидания не учитывается. По умолчанию 10 секунд.

  • :profile - если установлено в :time, измеряйте время компиляции каждого цикла компиляции и проверяйте прохождение групп

  • :dest - целевая директория для BEAM-файлов. При использовании compile/2, эта информация используется только для правильной аннотации BEAM-файлов перед загрузкой в память. Если вы хотите, чтобы файл был фактически записан в dest, используйте compile_to_path/3 вместо этого.

  • :beam_timestamp - отметка времени изменения для всех BEAM-файлов

  • :return_diagnostics (с v1.15.0) - возвращает карты с информацией вместо списка предупреждений и возвращает диагностические данные как карты вместо кортежей

compile_to_path(files, path, options \\ [])Источник

@spec compile_to_path([Path.t()], Path.t(), keyword()) ::
  {:ok, [atom()], [warning()] | info()}
  | {:error, [error()] | [Code.diagnostic(:error)], [warning()] | info()}

Компилирует заданные файлы и записывает получившиеся BEAM-файлы в путь.

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

pmap(collection, fun)Источник

Выполняет параллельную компиляцию collection с помощью fun.

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

require(files, options \\ [])Источник

@spec require(
  [Path.t()],
  keyword()
) ::
  {:ok, [atom()], [warning()] | info()}
  | {:error, [error()] | [Code.diagnostic(:error)], [warning()] | info()}

Загружает заданные файлы параллельно.

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

Возвращает {:ok, modules, warnings} или {:error, errors, warnings} по умолчанию, но рекомендуется использовать return_diagnostics: true, чтобы она возвращала диагностические данные как карты, а также карту информации о компиляции. Карта имеет структуру:

%{
  runtime_warnings: [warning],
  compile_warnings: [warning]
}

Параметры

  • :each_file - для каждого скомпилированного файла вызывает обратный вызов, передавая файл

  • :each_module - для каждого скомпилированного модуля вызывает обратный вызов, передавая файл, модуль и байт-код модуля

Скачать версию ePub

Создано с помощью ExDoc (v0.34.1) для языка программирования Elixir

© 2012-2024 The Elixir Team
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.17.2/Kernel.ParallelCompiler.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API