Spec-Zone.ru › Elixir 1.9

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

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

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

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

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

Типы

kind()

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

stacktrace()
stacktrace_entry()
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 так, как показано в трассировках стека. Если какие-либо значения nil, они опускаются.

format_mfa(module, fun, arity)

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

format_stacktrace(trace \\ nil)

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

format_stacktrace_entry(entry)

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

message(exception)

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

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

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

Обработчики

blame(t, stacktrace)

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

exception(term)
message(t)

Типы

kind()

Спецификации

kind() :: :error | non_error_kind()

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

stacktrace()

Спецификации

stacktrace() :: [stacktrace_entry()]

stacktrace_entry()

Спецификации

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

t()

Спецификации

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

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

Функции

blame(kind, error, stacktrace)

Спецификации

blame(:error, any(), stacktrace()) :: {t(), stacktrace()}
blame(non_error_kind(), payload, stacktrace()) :: {payload, stacktrace()}
when payload: var

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

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

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

blame_mfa(module, function, args)

Спецификации

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

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

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

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

exception?(term)

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

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

Спецификации

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

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

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

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

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

Спецификации

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

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

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

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

format_exit(reason)

Спецификации

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

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

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

format_fa(fun, arity)

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

Примеры

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

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

Форматирует указанный 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_mfa(module, fun, arity)

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

Примеры

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/arity»

format_stacktrace(trace \\ nil)

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

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

format_stacktrace_entry(entry)

Спецификации

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

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

message(exception)

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

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

Спецификации

normalize(:error, any(), stacktrace()) :: t()
normalize(non_error_kind(), payload, stacktrace()) :: payload when payload: var

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

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

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

Обработчики

blame(t, stacktrace)

Спецификации

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

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

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

exception(term)

Спецификации

exception(term()) :: t()

message(t)

Спецификации

message(t()) :: String.t()

© 2012 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.9.4/Exception.html

Spec-Zone.ru

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