Spec-Zone.ru › Elixir 1.8

Inspect.Opts

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

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

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

  • :binaries - когда :as_strings все двоичные данные будут выведены как строки, непечатаемые байты будут экранированы.

    Когда :as_binaries все двоичные данные будут выведены в двоичном формате.

    По умолчанию :infer, двоичные данные выводятся как строка, если она является печатаемой, в противном случае — в двоичном формате.

  • :charlists - когда :as_charlists все списки будут выведены как списки символов, непечатаемые элементы будут экранированы.

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

    По умолчанию :infer, список выводится как список символов, если он печатаемый, в противном случае — как список.

  • :limit - ограничивает количество элементов, выводимых для кортежей, битовых строк, отображений, списков и других коллекций элементов. Не применяется к строкам и спискам символов и по умолчанию равен 50. Если вы не хотите ограничивать количество элементов конкретным числом, используйте :infinity.

  • :printable_limit - ограничивает количество байтов, выводимых для строк и списков символов. По умолчанию 4096. Если вы не хотите ограничивать количество элементов конкретным числом, используйте :infinity.

  • :pretty - если установлено в true включает красивую печать, по умолчанию false.

  • :width - по умолчанию 80 символов, используется при красивой печати true или при выводе на устройства ввода/вывода. Установите в 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.

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

Типы

color_key()
t()

Типы

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,
  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
}

© 2012 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.8.2/Inspect.Opts.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API