NativeElixirPdfUtilities.Split (native_elixir_pdf_utilities v0.18.0)

Rebuilds one PDF as multiple valid PDF documents.

Page numbers are one-based and follow the source document's page-tree order. Ranges are inclusive, ascending, and must use a step of one. Every output receives a new catalog, page tree, cross-reference table, and trailer.

Summary

Types

error_reason()

Functions

after_page(pdf, page_number)

Rebuilds a PDF as two non-empty PDFs split after page_number.

by_page(pdf)

Rebuilds every source page as an individual PDF.

by_ranges(pdf, ranges)

Rebuilds each inclusive source-page range as a separate PDF.

Types

error_reason()

@type error_reason() ::
  :encrypted_pdf
  | :invalid_page_range
  | :invalid_page_selection
  | :invalid_pdf_input
  | :page_out_of_bounds
  | :resource_limit_exceeded
  | :unsupported_pdf_feature

Functions

after_page(pdf, page_number)

@spec after_page(binary(), pos_integer()) ::
  {:ok, {binary(), binary()}}
  | {:error,
     {error_reason(), NativeElixirPdfUtilities.Diagnostics.diagnostic()}}

Rebuilds a PDF as two non-empty PDFs split after page_number.

The selected page is the final page in the first output. The split point must be between page one and the penultimate page. The configured split output limit must allow two outputs.

by_page(pdf)

@spec by_page(binary()) ::
  {:ok, [binary()]}
  | {:error,
     {error_reason(), NativeElixirPdfUtilities.Diagnostics.diagnostic()}}

Rebuilds every source page as an individual PDF.

A document with no pages returns an empty output list. The configured split output limit must allow one output per source page.

by_ranges(pdf, ranges)

@spec by_ranges(binary(), [Range.t()]) ::
  {:ok, [binary()]}
  | {:error,
     {error_reason(), NativeElixirPdfUtilities.Diagnostics.diagnostic()}}

Rebuilds each inclusive source-page range as a separate PDF.

The range list must be non-empty. Every range must be ascending and use a step of one. Ranges may overlap because each range describes an independent output. The configured split output limit must allow one output per range.