Inspect.Opts

Определяет опции, используемые протоколом Inspect.

Доступны следующие поля:

:base - выводит целые числа и двоичные данные как :binary, :octal, :decimal или :hex. По умолчанию :decimal.
:binaries - при :as_binaries все двоичные данные будут выведены в битовой записи.

При :as_strings все двоичные данные будут выведены как строки, а непечатьмые байты будут экранированы.

При использовании значения по умолчанию :infer, двоичные данные будут выведены как строки, если :base равно :decimal и если они удобочитаемы, в противном случае — в битовой записи. См. String.printable?/1, чтобы узнать, когда строка является удобочитаемой.
:charlists - при :as_charlists все списки будут выведены как списки символов, а неудобочитаемые элементы будут экранированы.

При :as_lists все списки будут выведены как списки.

При использовании значения по умолчанию :infer, список будет выведен как список символов, если он удобочитаем, в противном случае — как список. См. List.ascii_printable?/1, чтобы узнать, когда список является удобочитаемым.
:custom_options (с версии v1.9.0) - ключевой список, хранящий пользовательские опции. Полезно при реализации протокола Inspect для вложенных структур, чтобы передать пользовательские опции.

Поддерживает некоторые предопределённые ключи:
- :sort_maps (с версии v1.14.4) - если установлено значение true, сортирует пары ключ-значение в картах. Это может быть полезно для обеспечения детерминированного просмотра карт для тестирования, учитывая, что порядок ключей карт является случайным.
:inspect_fun (с версии v1.9.0) - функция для построения документов алгебры. По умолчанию Inspect.Opts.default_inspect_fun/0.
:limit - ограничивает количество элементов, которые просматриваются для кортежей, битовых строк, карт, списков и любых других коллекций элементов, за исключением удобочитаемых строк и удобочитаемых списков символов, использующих опцию :printable_limit. Если вы не хотите ограничивать количество элементов конкретным числом, используйте :infinity. Принимает положительное целое число или :infinity. По умолчанию 50.
:pretty - если установлено значение true, включает красивую печать. По умолчанию false.
:printable_limit - ограничивает количество символов, которые просматриваются в удобочитаемых строках и удобочитаемых списках символов. Вы можете использовать String.printable?/1 и List.ascii_printable?/1, чтобы проверить, является ли заданная строка или список символов удобочитаемым. Если вы не хотите ограничивать количество символов конкретным числом, используйте :infinity. Принимает положительное целое число или :infinity. По умолчанию 4096.
:safe - если false, ошибки при просмотре структур будут подниматься в виде ошибок вместо того, чтобы быть обернутыми в исключение Inspect.Error. Это полезно при отладке ошибок и сбоев для пользовательских реализаций inspect. По умолчанию true.
:structs - если false, структуры не форматируются протоколом inspect, а вместо этого выводятся как карты. По умолчанию true.
:syntax_colors - если установлено значение, которое является списком ключевых слов цветов, вывод будет цветным. Ключами являются типы, а значениями — цвета для каждого типа (например, [number: :red, atom: :blue]). Типы могут включать :atom, :binary, :boolean, :list, :map, :number, :regex, :string, :tuple или некоторые типы для представления AST, такие как :variable, :call и :operator. Пользовательские типы данных могут предоставлять свои собственные опции. Цвета могут быть любыми IO.ANSI.ansidata/0, как принимается IO.ANSI.format/1. Список цветов по умолчанию можно получить из IO.ANSI.syntax_colors/0.
:width - количество символов в строке, используемых при красивой печати true или при выводе в устройства ввода-вывода. Установите значение 0, чтобы каждый элемент выводился в отдельной строке. Если вы не хотите ограничивать количество элементов конкретным числом, используйте :infinity. По умолчанию 80.

Функции

default_inspect_fun(): Возвращает функцию inspect по умолчанию.
default_inspect_fun(fun): Устанавливает функцию inspect по умолчанию.
new(opts): Создаёт структуру Inspect.Opts.

color_key()Источник

@type color_key() :: atom()

t()Источник

@type t() :: %Inspect.Opts{
  base: :decimal | :binary | :hex | :octal,
  binaries: :infer | :as_binaries | :as_strings,
  char_lists: term(),
  charlists: :infer | :as_lists | :as_charlists,
  custom_options: keyword(),
  inspect_fun: (any(), t() -> Inspect.Algebra.t()),
  limit: non_neg_integer() | :infinity,
  pretty: boolean(),
  printable_limit: non_neg_integer() | :infinity,
  safe: boolean(),
  structs: boolean(),
  syntax_colors: [{color_key(), IO.ANSI.ansidata()}],
  width: non_neg_integer() | :infinity
}

default_inspect_fun()Источник

@spec default_inspect_fun() :: (term(), t() -> Inspect.Algebra.t())

Возвращает функцию inspect по умолчанию.

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

@spec default_inspect_fun((term(), t() -> Inspect.Algebra.t())) :: :ok

Устанавливает функцию inspect по умолчанию.

Будьте осторожны при установке этой опции, так как она изменит способ просмотра всех значений в системе. Основное использование этой функциональности — предоставление точки входа для фильтрации просматриваемых значений, чтобы сущности соответствовали правилам и законодательству о безопасности и конфиденциальности данных.

Категорически не рекомендуется библиотекам устанавливать собственную функцию, так как она должна контролироваться приложениями. Библиотеки вместо этого должны определять свои собственные структуры с пользовательскими реализациями inspect. Если библиотеке необходимо изменить функцию inspect по умолчанию, лучше всего попросить пользователей вашей библиотеки явно вызвать default_inspect_fun/1 с вашей функцией.

По умолчанию Inspect.inspect/2.

Примеры

previous_fun = Inspect.Opts.default_inspect_fun()

Inspect.Opts.default_inspect_fun(fn
  %{address: _} = map, opts ->
    previous_fun.(%{map | address: "[REDACTED]"}, opts)

  value, opts ->
    previous_fun.(value, opts)
end)

new(opts)Источник

@spec new(keyword()) :: t()

Создаёт структуру Inspect.Opts.