Enum OcrMode 

pub enum OcrMode {
    Default,
    FullPage,
    LayoutRegions,
    PdfAwareLayoutRegions,
}

Which document regions feed the OCR — docling 2.116’s OcrMode (#254, upstream docling#3710). Upstream restructured its pipeline so OCR runs after layout, on layout regions filtered by the PDF text layer — the architecture this port has always had — and named the strategies:

• PdfAwareLayoutRegions (upstream’s default): OCR only layout regions the embedded text layer can’t cover. Exactly the standard path here — scanned pages OCR their regions, digital pages OCR only text-less bitmap areas.
• FullPage / LayoutRegions: ignore the PDF text layer and OCR everything. Both map onto the force_full_page_ocr machinery (discard the text layer, OCR every layout region): the upstream distinction — whole-page vs per-region detector input — has no analogue in this engine, whose PP-OCR recognizer always consumes per-region line crops.

Variants

Default

Upstream’s default: currently wired to PdfAwareLayoutRegions.

FullPage

OCR the full page, text layer ignored (docling’s full_page; the mode-shaped spelling of force_full_page_ocr).

LayoutRegions

OCR every layout region, text layer ignored (docling’s layout_regions).

PdfAwareLayoutRegions

OCR layout regions the text layer can’t cover (docling’s pdf_aware_layout_regions — the default behavior).

Implementations

impl OcrMode

pub fn parse(s: &str) -> Option<Self>

Parse docling’s mode ids. None for anything else — callers surface their own error/warning.

pub fn from_env() -> Self

The process-level choice from DOCLING_RS_OCR_MODE (empty/unset → the default; unknown values warn and use the default).

pub fn forces_full_page(self) -> bool

Whether this mode discards the embedded text layer — the engine truth both non-default modes reduce to.

Trait Implementations

impl Clone for OcrMode

fn clone(&self) -> OcrMode

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() -> OcrMode

Returns the “default value” for a type.

impl Eq for OcrMode

impl PartialEq for OcrMode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OcrMode