Struct PdfOptions 

pub struct PdfOptions {
    pub mode: ProcessMode,
    pub detection: DetectionConfig,
    pub markdown: MarkdownOptions,
    pub page_filter: Option<HashSet<u32>>,
    pub password: Option<String>,
}

Configuration for process_pdf_with_options and friends.

Use the builder methods to customise behaviour:

use pdf_inspector::{PdfOptions, ProcessMode};

let opts = PdfOptions::new()
    .mode(ProcessMode::Analyze)
    .pages([1, 3, 5]);

Fields

mode: ProcessMode

How far the pipeline should run (default: ProcessMode::Full).

detection: DetectionConfig

Detection configuration.

markdown: MarkdownOptions

Markdown formatting options (only used in ProcessMode::Full).

page_filter: Option<HashSet<u32>>

Optional set of 1-indexed pages to process. None = all pages.

password: Option<String>

Password for decrypting an encrypted PDF. None falls back to the empty password (owner-only encryption).

Implementations

impl PdfOptions

pub fn new() -> Self

Create options with all defaults (ProcessMode::Full).

pub fn detect_only() -> Self

Shorthand for detect-only options.

pub fn mode(self, mode: ProcessMode) -> Self

Set the processing mode.

pub fn detection(self, config: DetectionConfig) -> Self

Set detection configuration.

pub fn markdown(self, options: MarkdownOptions) -> Self

Set markdown formatting options.

pub fn pages(self, pages: impl IntoIterator<Item = u32>) -> Self

Limit processing to specific 1-indexed pages.

pub fn password(self, password: impl Into<String>) -> Self

Set the password used to decrypt an encrypted PDF.

Trait Implementations

impl Clone for PdfOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PdfOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PdfOptions

fn default() -> Self

Returns the “default value” for a type.