Inspect.Opts

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

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

:structs - когда false, структуры не форматируются протоколом inspect, а вместо этого выводятся как карты, по умолчанию true.
:binaries - когда :as_strings все двоичные данные будут выводиться как строки, непечатаемые байты будут экранированы.

Когда :as_binaries все двоичные данные будут выводиться в битовой нотации.

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

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

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

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

Типы

color_key()

Спецификации

color_key() :: atom()

t()

Спецификации

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