Enum OcrMode 

#[non_exhaustive]
pub enum OcrMode {
    Never,
    Auto,
    Force,
}

Whether extraction recognizes pages that need it before reading them.

The engine default is OcrMode::Never, so default output never changes under an OCR install: a caller opts in per call. The pymupdf4llm front door maps upstream’s use_ocr onto OcrMode::Auto and force_ocr onto OcrMode::Force.

Non-exhaustive: re-exported from the facade, so new modes must not break a downstream match.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Never

No OCR: read what the document draws. The default.

Auto

OCR the pages that need it – the ones under pdf-ocr’s text threshold – and leave the rest untouched. With no tesseract

Force

OCR every page in the window. On a page that already has a text layer the OCR layer REPLACES the native text for that page; without a tesseract binary this raises naming it, where upstream stays silent.

Trait Implementations

impl Clone for OcrMode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OcrMode

impl Debug for OcrMode

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

Formats the value using the given formatter.

impl Default for OcrMode

fn default() -> Self

Returns the “default value” for a type.

impl Eq for OcrMode

impl PartialEq for OcrMode

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for OcrMode