Source 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 (с версии 1.9.0) - список ключевых слов, содержащий настраиваемые опции пользователя. Полезно при реализации протокола Inspect для вложенных структур, чтобы передать настраиваемые опции.

Поддерживает некоторые предопределенные ключи:
- :sort_maps (с версии 1.14.4) - если установлено в true, сортирует пары ключ-значение в картах. Это может быть полезно для обеспечения детерминированного просмотра карт при тестировании, так как порядок ключей карт случайный.
:inspect_fun (с версии 1.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 или при выводе на устройства IO. Установите 0 для вывода каждого элемента на отдельной строке. Если вы не хотите ограничивать количество элементов определенным числом, используйте :infinity. По умолчанию 80.

Резюме

Функции

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

Типы

color_key()Source

@type color_key() :: atom()

t()Source

@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()Source

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

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

default_inspect_fun(fun)Source

@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)Source

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

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

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