Tincture.Layout.Template.DocumentResult (Tincture v0.1.0)

Copy Markdown View Source

The outcome of a paginated render.

pages_used is how many pages were produced. overflow? is true when the content ran past :max_pages, in which case spill_text holds what never made it onto a page.

Summary

Types

t()

Types

t()

@type t() :: %Tincture.Layout.Template.DocumentResult{
  overflow?: boolean(),
  page_results: [Tincture.Layout.Template.RenderResult.t()],
  pages_used: non_neg_integer(),
  spill_text: String.t()
}