Протокол inspect

Протокол Inspect преобразует структуру данных Elixir в документ алгебры.

Данная документация посвящена реализации протокола Inspect для собственных структур данных. Чтобы узнать больше о использовании inspect, см. Kernel.inspect/2 и IO.inspect/2.

Функция inspect/2 получает сущность для проверки и параметры проверки, представленные структурой Inspect.Opts. Построение документа алгебры выполняется с помощью Inspect.Algebra.

Примеры

Часто проверка структуры может быть реализована на основе существующих сущностей. Например, вот реализация MapSet для inspect/2:

defimpl Inspect, for: MapSet do
  import Inspect.Algebra

  def inspect(dict, opts) do
    concat(["#MapSet<", to_doc(MapSet.to_list(dict), opts), ">"])
  end
end

Функция concat/1 из Inspect.Algebra объединяет документы алгебры вместе. В приведенном примере она объединяет строку "MapSet<" (все строки являются допустимыми документами алгебры, которые сохраняют свой форматирование при красивом выводе), документ, возвращаемый Inspect.Algebra.to_doc/2, и другую строку ">".

Поскольку обычные строки являются допустимыми сущностями в документе алгебры, реализация протокола Inspect может просто вернуть строку, хотя это лишит её красивого вывода.

Обработка ошибок

В случае возникновения ошибки во время проверки структуры Elixir поднимет ошибку ArgumentError и автоматически вернётся к исходному представлению для вывода структуры.

Однако вы можете получить доступ к основной ошибке, вызвав реализацию Inspect напрямую. Например, для проверки Inspect.MapSet выше, вы можете вызвать её следующим образом:

Inspect.MapSet.inspect(MapSet.new(), %Inspect.Opts{})

Вывод

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

Параметры :only и :except могут быть использованы с @derive для указания, какие поля должны и не должны отображаться в документе алгебры:

defmodule User do
  @derive {Inspect, only: [:id, :name]}
  defstruct [:id, :name, :address]
end

inspect(%User{id: 1, name: "Homer", address: "742 Evergreen Terrace"})
#=> #User<id: 1, name: "Homer", ...>

Сводка

Типы

t()

Функции

inspect(term, opts)

Типы

t()

t() :: term()

Функции

inspect(term, opts)