ExPdfInspector.PdfOptions (ExPdfInspector v0.1.0)

Copy Markdown View Source

Defines the options used to process a PDF.

Full processing is the default. You can detect only the document type or restrict extraction to specific pages:

%ExPdfInspector.PdfOptions{mode: :detect_only}

%ExPdfInspector.PdfOptions{page_filter: [0, 2]}

page_filter uses zero-based page indexes. Set password when the PDF is password-protected.

Summary

Types

mode()

The processing steps to run.

t()

Options used to process a PDF.

Types

mode()

@type mode() :: :detect_only | :analyze | :full

The processing steps to run.

t()

@type t() :: %ExPdfInspector.PdfOptions{
  detection: ExPdfInspector.DetectionOptions.t(),
  markdown: ExPdfInspector.MarkdownOptions.t(),
  mode: mode(),
  page_filter: [non_neg_integer()] | nil,
  password: String.t() | nil
}

Options used to process a PDF.