Источник Inspect.Opts

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

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

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

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

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

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

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

Поддерживает некоторые предопределенные ключи:
- :sort_maps (с версии v1.14.4) - если установлено значение true, сортирует пары ключ-значение в картах. Это может быть полезно, чтобы сделать проверку карты детерминированной для тестирования, учитывая, что порядок ключей карты случайный.
:inspect_fun (с версии v1.9.0) - функция для построения документов алгебры. По умолчанию Inspect.Opts.default_inspect_fun/0.
:limit - ограничивает количество элементов, проверяемых для кортежей, битовых строк, карт, списков и любых других коллекций элементов, за исключением печатаемых строк и печатаемых charlist, которые используют опцию :printable_limit. Если вы не хотите ограничивать количество элементов конкретным числом, используйте :infinity. Принимает положительное целое число или :infinity. По умолчанию 50.
:pretty - если установлено значение true, включает красивую печать. По умолчанию false.
:printable_limit - ограничивает количество символов, проверяемых в печатаемых строках и печатаемых charlist. Вы можете использовать String.printable?/1 и List.ascii_printable?/1 для проверки, является ли заданная строка или charlist печатаемой. Если вы не хотите ограничивать количество символов конкретным числом, используйте :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(): Возвращает функцию проверки по умолчанию.
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

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

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

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

© 2012-2024 The Elixir Team
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.18.1/Inspect.Opts.html