PdfElixide (pdf_elixide v0.1.0)

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

Summary

Types

t()

Functions

extract_text(doc, page_index)

Extracts the text content of the page at the given zero-based index.

extract_text!(doc, page_index)

Extracts the text content of the page at the given zero-based index, raising an error if it fails.

from_binary(bytes)

Opens a PDF document from the given binary data.

from_binary!(bytes)

Opens a PDF document from the given binary data, raising an error if it fails.

open(path)

Opens a PDF document from the specified file path.

open!(path)

Opens a PDF document from the specified file path, raising an error if it fails.

page_count(doc)

Returns the number of pages in the given PDF document.

page_count!(doc)

Returns the number of pages in the given PDF document, raising an error if it fails.

version(doc)

Returns the PDF specification version of the given document as a {major, minor} tuple.

version!(doc)

Returns the PDF specification version of the given document, raising an error if it fails.

Types

t()

@opaque t()

Functions

extract_text(doc, page_index)

@spec extract_text(t(), non_neg_integer()) :: {:ok, binary()} | {:error, term()}

Extracts the text content of the page at the given zero-based index.

extract_text!(doc, page_index)

@spec extract_text!(t(), non_neg_integer()) :: binary()

Extracts the text content of the page at the given zero-based index, raising an error if it fails.

from_binary(bytes)

@spec from_binary(binary()) :: {:ok, t()} | {:error, term()}

Opens a PDF document from the given binary data.

from_binary!(bytes)

@spec from_binary!(binary()) :: t()

Opens a PDF document from the given binary data, raising an error if it fails.

open(path)

@spec open(Path.t()) :: {:ok, t()} | {:error, term()}

Opens a PDF document from the specified file path.

open!(path)

@spec open!(Path.t()) :: t()

Opens a PDF document from the specified file path, raising an error if it fails.

page_count(doc)

@spec page_count(t()) :: {:ok, non_neg_integer()} | {:error, term()}

Returns the number of pages in the given PDF document.

page_count!(doc)

@spec page_count!(t()) :: non_neg_integer()

Returns the number of pages in the given PDF document, raising an error if it fails.

version(doc)

@spec version(t()) :: {:ok, {non_neg_integer(), non_neg_integer()}} | {:error, term()}

Returns the PDF specification version of the given document as a {major, minor} tuple.

version!(doc)

@spec version!(t()) :: {non_neg_integer(), non_neg_integer()}

Returns the PDF specification version of the given document, raising an error if it fails.