Inspect.Opts

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

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

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

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

При :as_lists все списки будут выведены как списки. При использовании значения по умолчанию :infer, список будет выведен как список символов, если он печатаемый, иначе как список. Обратитесь к List.ascii_printable?/1, чтобы узнать, когда список символов является печатаемым.
:custom_options (с версии v1.9.0) - ключевой список, хранящий пользовательские параметры. Полезно при реализации протокола Inspect для вложенных структур, чтобы передавать пользовательские параметры.
: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. Это полезно при отладке ошибок и сбоев для пользовательских реализаций инспектирования. По умолчанию true.
:structs - при false, структуры не форматируются протоколом инспектирования, а вместо этого выводятся как карты. По умолчанию true.
:syntax_colors - при установке в ключевой список цветов вывод становится цветным. Ключи — типы, значения — цвета для каждого типа (например, [number: :red, atom: :blue]). Типы могут включать :atom, :binary, :boolean, :list, :map, :number, :regex, :string, и :tuple. Пользовательские типы данных могут предоставлять свои собственные параметры. Цвета могут быть любыми IO.ANSI.ansidata/0, принятыми IO.ANSI.format/1. Список цветов по умолчанию можно получить из IO.ANSI.syntax_colors/0.
:width - количество символов на строку при использовании красивой печати true или при выводе в устройства ввода-вывода. Установите 0 чтобы вывести каждый элемент на отдельной строке. Если вы не хотите ограничивать количество элементов конкретным числом, используйте :infinity. По умолчанию 80.

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

Функции

default_inspect_fun(): Возвращает функцию инспектирования по умолчанию.
default_inspect_fun(fun): Устанавливает функцию инспектирования по умолчанию.
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())

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

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

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

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

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

Категорически не рекомендуется библиотекам устанавливать свои собственные функции, так как это должно контролироваться приложениями. Библиотеки должны вместо этого определять собственные структуры с пользовательскими реализациями инспектирования. Если библиотеке необходимо изменить функцию инспектирования по умолчанию, лучше всего попросить пользователей библиотеки явно вызвать 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.