NativeElixirPdfUtilities.Transform (native_elixir_pdf_utilities v0.18.0)

Rebuilds PDFs with selected, reordered, deleted, or rotated pages.

Page numbers are one-based and follow the source document's page-tree order. Page ranges are inclusive, ascending, and must use a step of one. Transform selections reject duplicate pages, including duplicates produced by overlapping selectors. Every successful operation writes a new catalog, page tree, cross-reference table, and trailer.

Rebuilding omits unselected page objects and resources used only by those pages. It is not secure redaction because retained pages can share resources with removed pages. Internal link annotations that target removed pages are omitted; links to retained pages and external URI links remain. Outline items targeting retained pages are remapped, while removed-page leaves are omitted.

Summary

Types

error_reason()

page_selector()

Functions

delete_pages(pdf, selection)

Rebuilds a PDF without the selected pages.

pick_pages(pdf, selection)

Rebuilds a PDF with the selected pages in the requested order.

rotate_pages(pdf, degrees, options \\ [])

Rebuilds a PDF after rotating selected pages clockwise.

Types

error_reason()

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

page_selector()

@type page_selector() :: pos_integer() | Range.t()

Functions

delete_pages(pdf, selection)

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

Rebuilds a PDF without the selected pages.

Page numbers refer to the original document and are evaluated together. Ranges must be inclusive, ascending, and use a step of one. Deleting every page is rejected. An empty selection rebuilds the document without removing any pages.

pick_pages(pdf, selection)

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

Rebuilds a PDF with the selected pages in the requested order.

Selection entries may be positive page numbers or inclusive, ascending, unit-step ranges. Duplicate pages and empty selections are rejected.

rotate_pages(pdf, degrees, options \\ [])

@spec rotate_pages(binary(), integer(), [{:pages, :all | [page_selector()]}]) ::
  {:ok, binary()}
  | {:error,
     {error_reason(), NativeElixirPdfUtilities.Diagnostics.diagnostic()}}

Rebuilds a PDF after rotating selected pages clockwise.

Rotation must be an integer multiple of 90 degrees and is added to each page's effective existing rotation. The :pages option accepts :all, which is the default, or a list of page numbers and inclusive, ascending, unit-step ranges.