API Reference pdf_elixide v#0.9.0

Copy Markdown View Source

Modules

Elixir bindings for pdf_oxide, a high-performance PDF library written in Rust.

The color values returned by extraction, one struct per colorspace.

A DeviceCMYK color — cyan, magenta, yellow, and key (black), each in the 0.0..1.0 range.

A DeviceGray color — a single intensity in the 0.0..1.0 range, where 0.0 is black and 1.0 is white.

A DeviceRGB color — red, green, and blue, each in the 0.0..1.0 range.

Color components whose colorspace could not be identified, preserved verbatim.

Read-only representation of a PDF document.

A single annotation on a PDF page — a link, sticky note, highlight, form widget, stamp, and so on — with its zero-based :page index.

Decoded /F annotation flags (ISO 32000-1 §12.5.3, Table 165).

A single character extracted from a PDF page, with its zero-based page index, bounding box, font metadata, and typographic placement.

A font referenced by a PDF page, with its zero-based page index, the page's font resource name, and metadata describing the face.

A raster image (photo, logo, scanned picture) extracted from a PDF page, with its zero-based page index, on-page bounding box, and dimensions.

Document Info dictionary metadata — a PDF's classic /Info fields.

A single item (bookmark) in a PDF document's outline — its table of contents.

Representation of a page of a PDF document.

A vector graphics path — a line, curve, rectangle, or filled shape — extracted from a PDF page, with its zero-based page index and bounding box.

Decoded /P permission flags from a PDF's standard encryption dictionary (ISO 32000-1 §7.6.3.2, Table 22).

A run of text sharing one text state — the same font, size, color, and text-state parameters — extracted from a PDF page, with its zero-based page index and bounding box.

A table detected on a PDF page, with its zero-based page index, bounding box, and rows.

A single cell of a detected table, with its text, geometry, spans, and grid placement.

A single row of a detected table, holding its cells.

A single line of text extracted from a PDF page, with its zero-based page index, bounding box, and constituent words.

A single word extracted from a PDF page, with its zero-based page index, bounding box, and font metadata.

XMP (Extensible Metadata Platform) metadata — the XML-based metadata packet a PDF may carry in addition to, or instead of, the /Info dictionary (PdfElixide.Document.Metadata).

Mutable, in-memory PDF editor backed by pdf_oxide's DocumentEditor.

Structured error raised or returned by PdfElixide operations.

Representation of the form fields within a PDF document.

Representation of a form field within a PDF document.

An axis-aligned rectangle in PDF user-space coordinates.