@spec break(binary()) :: doc_break()

Возвращает документ разрыва, основанный на заданной string.

Этот разрыв может быть отображён как перевод строки или как заданная string, в зависимости от mode выбранного макета.

Примеры

Давайте создадим документ, конкатенируя две строки с разрывом между ними:

iex> doc = Inspect.Algebra.concat(["a", Inspect.Algebra.break("\t"), "b"])
iex> Inspect.Algebra.format(doc, 80)
["a", "\t", "b"]

Обратите внимание, что разрыв был представлен заданной строкой, потому что мы не достигли предела строки. Как только мы это сделаем, он заменяется новой строкой:

iex> break = Inspect.Algebra.break("\t")
iex> doc = Inspect.Algebra.concat([String.duplicate("a", 20), break, "b"])
iex> doc = Inspect.Algebra.group(doc)
iex> Inspect.Algebra.format(doc, 10)
["aaaaaaaaaaaaaaaaaaaa", "\n", "b"]

@spec collapse_lines(pos_integer()) :: doc_collapse()

Сжимает все новые строки и пробелы, следующие за этим узлом, выводимые до max новых строк.

@spec color(t(), Inspect.Opts.color_key(), Inspect.Opts.t()) :: t()

Окрашивает документ, если color_key имеет цвет в опциях.

@spec concat([t()]) :: t()

Конкатенирует список документов, возвращая новый документ.

Примеры

iex> doc = Inspect.Algebra.concat(["a", "b", "c"])
iex> Inspect.Algebra.format(doc, 80)
["a", "b", "c"]

@spec concat(t(), t()) :: t()

Конкатенирует два сущности документа, возвращая новый документ.

Примеры

iex> doc = Inspect.Algebra.concat("hello", "world")
iex> Inspect.Algebra.format(doc, 80)
["hello", "world"]

@spec container_doc(
  t(),
  [any()],
  t(),
  Inspect.Opts.t(),
  (term(), Inspect.Opts.t() -> t()),
  keyword()
) ::
  t()

Оборачивает collection в left и right в соответствии с лимитом и содержимым.

Использует заданные left и right документы в качестве окружающих и документ-разделитель separator для разделения элементов в docs. Если все записи в коллекции являются простыми документами (текстами или строками), то эта функция пытается поместить как можно больше элементов в одну строку. Если они не простые, то отображается только одна запись в строке, если они не помещаются.

Предел в заданном inspect_opts соблюдается, и при его достижении эта функция прекращает обработку и выводит "..." вместо этого.

Опции

• :separator - разделитель, используемый между каждым документом
• :break - Если :strict, всегда вставляется разрыв между каждым элементом. Если :flex, разрывы вставляются только при необходимости. Если :maybe, выбирается :flex только если все элементы являются текстовыми, в противном случае :strict

Примеры

iex> inspect_opts = %Inspect.Opts{limit: :infinity}
iex> fun = fn i, _opts -> to_string(i) end
iex> doc = Inspect.Algebra.container_doc("[", Enum.to_list(1..5), "]", inspect_opts, fun)
iex> Inspect.Algebra.format(doc, 5) |> IO.iodata_to_binary()
"[1,\n 2,\n 3,\n 4,\n 5]"

iex> inspect_opts = %Inspect.Opts{limit: 3}
iex> fun = fn i, _opts -> to_string(i) end
iex> doc = Inspect.Algebra.container_doc("[", Enum.to_list(1..5), "]", inspect_opts, fun)
iex> Inspect.Algebra.format(doc, 20) |> IO.iodata_to_binary()
"[1, 2, 3, ...]"

iex> inspect_opts = %Inspect.Opts{limit: 3}
iex> fun = fn i, _opts -> to_string(i) end
iex> opts = [separator: "!"]
iex> doc = Inspect.Algebra.container_doc("[", Enum.to_list(1..5), "]", inspect_opts, fun, opts)
iex> Inspect.Algebra.format(doc, 20) |> IO.iodata_to_binary()
"[1! 2! 3! ...]"

@spec empty() :: :doc_nil

Возвращает сущность документа, используемую для представления пустоты.

Примеры

iex> Inspect.Algebra.empty()
:doc_nil

@spec flex_break(binary()) :: doc_break()

Возвращает документ гибкого разрыва, основанный на заданной string.

Гибкий разрыв всё ещё вызывает разрыв группы, как break/1, но он переоценивается при рендеринге документа.

Например, рассмотрим документ группы, представленный как [1, 2, 3], где пробел после каждой запятой является разрывом. Когда документ выше не помещается в одну строку, все разрывы активируются, что приводит к отображению документа как:

[1,
 2,
 3]

Однако, если используются гибкие разрывы, каждый разрыв переоценивается при рендеринге, поэтому документ может быть отображён как:

[1, 2,
 3]

Отсюда и название «гибкий». Они более гибкие, когда речь идёт о размещении документа. С другой стороны, они дороже, так как каждый разрыв нужно переоценивать.

Эта функция используется container_doc/6 и другими, чтобы определить максимальное количество элементов в одной строке.

@spec flex_glue(t(), binary(), t()) :: t()

Соединяет два документа (doc1 и doc2) вставляя flex_break/1, заданный break_string между ними.

Эта функция используется container_doc/6 и другими, чтобы определить максимальное количество элементов в одной строке.

@spec fold_doc([t()], (t(), t() -> t())) :: t()

Складывает список документов в один документ с использованием данной функции свертки.

Список документов складывается «справа»; в этом функция похожа на List.foldr/3, за исключением того, что она не ожидает начального аккумулятора и использует последний элемент docs в качестве начального аккумулятора.

Примеры

iex> docs = ["A", "B", "C"]
iex> docs =
...>   Inspect.Algebra.fold_doc(docs, fn doc, acc ->
...>     Inspect.Algebra.concat([doc, "!", acc])
...>   end)
iex> Inspect.Algebra.format(docs, 80)
["A", "!", "B", "!", "C"]

@spec force_unfit(t()) :: doc_force()

Принудительно делает текущую группу непригодной.

@spec format(t(), non_neg_integer() | :infinity) :: iodata()

Форматирует заданный документ для заданной ширины.

Принимает максимальную ширину и документ для печати в качестве аргументов и возвращает представление данных IO наилучшей компоновки для документа, чтобы он умещался в заданной ширине.

Документ начинается плоским (без разрывов) до тех пор, пока не будет найдена группа.

Примеры

iex> doc = Inspect.Algebra.glue("hello", " ", "world")
iex> doc = Inspect.Algebra.group(doc)
iex> doc |> Inspect.Algebra.format(30) |> IO.iodata_to_binary()
"hello world"
iex> doc |> Inspect.Algebra.format(10) |> IO.iodata_to_binary()
"hello\nworld"

@spec glue(t(), binary(), t()) :: t()

Соединяет два документа (doc1 и doc2) вставляя заданный разрыв break_string между ними.

Для получения дополнительной информации о том, как вставляется разрыв, см. break/1.

Примеры

iex> doc = Inspect.Algebra.glue("hello", "world")
iex> Inspect.Algebra.format(doc, 80)
["hello", " ", "world"]

iex> doc = Inspect.Algebra.glue("hello", "\t", "world")
iex> Inspect.Algebra.format(doc, 80)
["hello", "\t", "world"]

@spec group(t(), :self | :inherit) :: doc_group()

Возвращает группу, содержащую указанный документ doc.

Документы в группе пытаются отображаться вместе, насколько это возможно для рендерера.

Режим группы также может быть установлен на :inherit, что означает автоматический разрыв, если родительская группа также была разделена.

Примеры

iex> doc =
...>   Inspect.Algebra.group(
...>     Inspect.Algebra.concat(
...>       Inspect.Algebra.group(
...>         Inspect.Algebra.concat(
...>           "Hello,",
...>           Inspect.Algebra.concat(
...>             Inspect.Algebra.break(),
...>             "A"
...>           )
...>         )
...>       ),
...>       Inspect.Algebra.concat(
...>         Inspect.Algebra.break(),
...>         "B"
...>       )
...>     )
...>   )
iex> Inspect.Algebra.format(doc, 80)
["Hello,", " ", "A", " ", "B"]
iex> Inspect.Algebra.format(doc, 6)
["Hello,", "\n", "A", "\n", "B"]

@spec line() :: t()

Обязательный разрыв строки.

Группа с разрывами строк будет размещена, если все строки в группе помещаются.

Примеры

iex> doc =
...>   Inspect.Algebra.concat(
...>     Inspect.Algebra.concat(
...>       "Hughes",
...>       Inspect.Algebra.line()
...>     ),
...>     "Wadler"
...>   )
iex> Inspect.Algebra.format(doc, 80)
["Hughes", "\n", "Wadler"]

@spec line(t(), t()) :: t()

Вставляет обязательный разрыв строки между двумя документами.

См. line/0.

Примеры

iex> doc = Inspect.Algebra.line("Hughes", "Wadler")
iex> Inspect.Algebra.format(doc, 80)
["Hughes", "\n", "Wadler"]

@spec nest(t(), non_neg_integer() | :cursor | :reset, :always | :break) :: doc_nest()

Вкладывает данный документ в указанный level.

Если level — целое число, это отступ, добавляемый к разрывам строк при их появлении. Если уровень — :cursor, текущая позиция «курсора» в документе становится вложенностью. Если уровень — :reset, он устанавливается обратно в 0.

mode может быть :always, что означает, что вложение всегда происходит, или :break, что означает, что вложение происходит только внутри группы, которая была разбита.

Примеры

iex> doc = Inspect.Algebra.nest(Inspect.Algebra.glue("hello", "world"), 5)
iex> doc = Inspect.Algebra.group(doc)
iex> Inspect.Algebra.format(doc, 5)
["hello", "\n     ", "world"]

@spec next_break_fits(t(), :enabled | :disabled) :: doc_fits()

Рассматривает следующий разрыв как подходящий.

mode может быть :enabled или :disabled. При :enabled, документ будет считаться подходящим, как только найдется следующий разрыв, фактически отменяя разрыв. Он также проигнорирует любые force_unfit/1 при поиске следующего разрыва.

При отключенном режиме он ведет себя как обычно и игнорирует любые дальнейшие инструкции next_break_fits/2.

Примеры

Это используется форматировщиком кода Elixir, чтобы избежать разрыва кода в определенных местах. Например, рассмотрим этот код:

some_function_call(%{..., key: value, ...})

Теперь представьте, что этот код не помещается в строку. Форматировщик кода вставляет разрывы внутри ( и ) и внутри %{ и }. Поэтому документ будет разбит как:

some_function_call(
  %{
    ...,
    key: value,
    ...
  }
)

Форматировщик оборачивает документ алгебры, представляющий карту, в next_break_fits/1, чтобы код был отформатирован следующим образом:

some_function_call(%{
  ...,
  key: value,
  ...
})

@spec space(t(), t()) :: t()

Вставляет обязательный одиночный пробел между двумя документами.

Примеры

iex> doc = Inspect.Algebra.space("Hughes", "Wadler")
iex> Inspect.Algebra.format(doc, 5)
["Hughes", " ", "Wadler"]

@spec string(String.t()) :: doc_string()

Создает документ, представленный строкой.

В то время как Inspect.Algebra принимает двоичные данные в качестве документов, они учитываются по размеру в байтах. С другой стороны, string документы измеряются по количеству графем для определения размера документа.

Примеры

Следующий документ имеет 10 байт и поэтому не форматируется до ширины 9 без разрывов:

iex> doc = Inspect.Algebra.glue("olá", " ", "mundo")
iex> doc = Inspect.Algebra.group(doc)
iex> Inspect.Algebra.format(doc, 9)
["olá", "\n", "mundo"]

Однако, если мы используем string, тогда длина строки используется вместо размера в байтах, что правильно подходит:

iex> string = Inspect.Algebra.string("olá")
iex> doc = Inspect.Algebra.glue(string, " ", "mundo")
iex> doc = Inspect.Algebra.group(doc)
iex> Inspect.Algebra.format(doc, 9)
["olá", " ", "mundo"]

@spec to_doc(any(), Inspect.Opts.t()) :: t()

Преобразует термин Elixir в документ алгебры в соответствии с протоколом Inspect.