Исключение поведение

Функции для форматирования выбрасываемых/перехватываемых/выходных значений и исключений.

Обратите внимание, что трассировки стека в Elixir доступны только внутри catch и rescue с использованием переменной __STACKTRACE__/0.

Не полагайтесь на конкретный формат, возвращаемый функциями format* в этом модуле. Они могут быть изменены в будущих версиях для лучшей интеграции с инструметальными средствами Elixir. Другими словами, используя функции в этом модуле, гарантируется, что вы будете форматировать исключения так, как это реализовано в текущей версии Elixir.

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

Типы

arity_or_args()
kind(): Тип, обрабатываемый функциями форматирования
location()
non_error_kind()
stacktrace()
stacktrace_entry()
t(): Тип исключения

Обработчики

blame(t, stacktrace): Вызывается из Exception.blame/3 для дополнения структуры исключения.
exception(term)
message(t)

Функции

blame(kind, error, stacktrace): Прикрепляет информацию к исключениям для дополнительной отладки.
blame_mfa(module, function, args): Присваивает вину вызову указанного модуля, функции и аргументов.
exception?(term) устаревшее: Возвращает true , если заданное значение term является исключением.
format(kind, payload, stacktrace \\ []): Нормализует и форматирует выбрасываемые/ошибочные/выходные значения и трассировки стека.
format_banner(kind, exception, stacktrace \\ []): Нормализует и форматирует любые выбрасываемые/ошибочные/выходные значения.
format_exit(reason): Форматирует выход. Возвращает строку.
format_fa(fun, arity): Принимает анонимную функцию и арность и форматирует её так, как показано в трассировках стека. Арность также может быть списком аргументов.
format_file_line(file, line, suffix \\ ""): Форматирует заданный file и line так, как показано в трассировках стека.
format_file_line_column(file, line, column, suffix \\ ""): Форматирует заданный file, line, и column так, как показано в трассировках стека.
format_mfa(module, fun, arity): Принимает модуль, функцию и арность и форматирует их так, как показано в трассировках стека. Арность также может быть списком аргументов.
format_stacktrace(trace \\ nil): Форматирует трассировку стека.
format_stacktrace_entry(entry): Принимает запись трассировки стека и форматирует её в строку.
message(exception): Получает сообщение для exception.
normalize(kind, payload, stacktrace \\ []): Нормализует исключение, преобразуя исключения Erlang в исключения Elixir.

Типы

arity_or_args()Source

@type arity_or_args() :: non_neg_integer() | list()

kind()Source

@type kind() :: :error | non_error_kind()

Тип, обрабатываемый функциями форматирования

location()Source

@type location() :: keyword()

non_error_kind()Source

@type non_error_kind() :: :exit | :throw | {:EXIT, pid()}

stacktrace()Source

@type stacktrace() :: [stacktrace_entry()]

stacktrace_entry()Source

@type stacktrace_entry() ::
  {module(), atom(), arity_or_args(), location()}
  | {(... -> any()), arity_or_args(), location()}

t()Source

@type t() :: %{
  :__struct__ => module(),
  :__exception__ => true,
  optional(atom()) => any()
}

Тип исключения

Обработчики

blame(t, stacktrace)Source

@callback blame(t(), stacktrace()) :: {t(), stacktrace()}

Вызывается из Exception.blame/3 для дополнения структуры исключения.

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

exception(term)Source

@callback exception(term()) :: t()

message(t)Source

@callback message(t()) :: String.t()

Функции

blame(kind, error, stacktrace)Source

@spec blame(:error, any(), stacktrace()) :: {t(), stacktrace()}

@spec blame(non_error_kind(), payload, stacktrace()) :: {payload, stacktrace()}
when payload: var

Прикрепляет информацию к исключениям для дополнительной отладки.

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

Если модуль исключения реализует необязательный blame/2 обратный вызов, он будет вызван для выполнения вычислений.

blame_mfa(module, function, args)Source

@spec blame_mfa(module(), function :: atom(), args :: [term()]) ::
  {:ok, :def | :defp | :defmacro | :defmacrop,
   [{args :: [term()], guards :: [term()]}]}
  | :error

Назначает вину вызову данного модуля, функции и аргументов.

Эта функция получит доступные клаузы из байткода и проверит их по заданным аргументам. Клаузы возвращаются как список пар {args, guards} , где каждый аргумент и каждое условие верхнего уровня в огранке, разделенные and/or, заключены в кортеж с метаданными вины.

Эта функция возвращает либо {:ok, definition, clauses}, либо :error. Где definition является :def, :defp, :defmacro или :defmacrop.

exception?(term)Source

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

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

format(kind, payload, stacktrace \\ [])Source

@spec format(kind(), any(), stacktrace()) :: String.t()

Нормализует и форматирует выбрасывания/ошибки/выходы и трассы стека.

Опирается на format_banner/3 и format_stacktrace/1 для генерации окончательного формата.

Если kind является {:EXIT, pid}, не генерируется трасса стека, так как такие выходы извлекаются как сообщения без трасс стека.

format_banner(kind, exception, stacktrace \\ [])Source

@spec format_banner(kind(), any(), stacktrace()) :: String.t()

Нормализует и форматирует любой выбрасывание/ошибку/выход.

Сообщение форматируется и отображается в том же формате, что и в командной строке Elixir.

Третий аргумент — трасса стека, используемая для обогащения нормализованной ошибки дополнительной информацией. Используется только в случае, если тип — ошибка.

format_exit(reason)Source

@spec format_exit(any()) :: String.t()

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

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

format_fa(fun, arity)Source

Принимает анонимную функцию и арность и форматирует её так, как это показано в трассах стека. Арность также может быть списком аргументов.

Примеры

Exception.format_fa(fn -> nil end, 1)
#=> "#Function<...>/1"

format_file_line(file, line, suffix \\ "")Source

Форматирует указанный file и line так, как это отображается в трассах стека.

Если какие-либо значения равны nil, они опускаются.

Примеры

iex> Exception.format_file_line("foo", 1)
"foo:1:"

iex> Exception.format_file_line("foo", nil)
"foo:"

iex> Exception.format_file_line(nil, nil)
""

format_file_line_column(file, line, column, suffix \\ "")Source

Форматирует указанные file, line, и column так, как это отображается в трассах стека.

Если какие-либо значения равны nil, они опускаются.

Примеры

iex> Exception.format_file_line_column("foo", 1, 2)
"foo:1:2:"

iex> Exception.format_file_line_column("foo", 1, nil)
"foo:1:"

iex> Exception.format_file_line_column("foo", nil, nil)
"foo:"

iex> Exception.format_file_line_column("foo", nil, 2)
"foo:"

iex> Exception.format_file_line_column(nil, nil, nil)
""

format_mfa(module, fun, arity)Source

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

Примеры

iex> Exception.format_mfa(Foo, :bar, 1)
"Foo.bar/1"

iex> Exception.format_mfa(Foo, :bar, [])
"Foo.bar()"

iex> Exception.format_mfa(nil, :bar, [])
"nil.bar()"

Анонимные функции отображаются как -func/arity-anonfn-count-, где func — имя функции-обёртки. Преобразовать в «анонимная функция в func/арность»

format_stacktrace(trace \\ nil)Source

Форматирует трассу стека.

Трасса стека должна быть задана в качестве аргумента. В противном случае, трасса стека извлекается из Process.info/2.

format_stacktrace_entry(entry)Source

@spec format_stacktrace_entry(stacktrace_entry()) :: String.t()

Принимает запись трассы стека и форматирует её в строку.

message(exception)Source

Получает сообщение для exception.

normalize(kind, payload, stacktrace \\ [])Source

@spec normalize(:error, any(), stacktrace()) :: t()

@spec normalize(non_error_kind(), payload, stacktrace()) :: payload when payload: var

Нормализует исключение, преобразуя исключения Erlang в исключения Elixir.

Принимает kind, выброшенные catch в качестве аргумента и нормализует только :error, возвращая нетронутый payload для других.