Enum ReadingOrderMode 

pub enum ReadingOrderMode {
    TopToBottomLeftToRight,
    ColumnAware,
    StructureTreeFirst {
        mcid_order: Vec<u32>,
    },
}

Reading order determination mode for text blocks.

Determines how text blocks are ordered when converting to output formats.

Variants

TopToBottomLeftToRight

Simple top-to-bottom, left-to-right ordering.

Sorts all blocks by Y coordinate (top to bottom), then by X coordinate (left to right). This works well for single-column documents.

ColumnAware

Column-aware reading order.

Uses the XY-Cut algorithm to detect columns and determines proper reading order across multiple columns. This works better for multi-column documents.

StructureTreeFirst

Structure tree first, with fallback to column-aware.

For Tagged PDFs: Uses the PDF logical structure tree (ISO 32000-1:2008 Section 14.7) to determine reading order via Marked Content IDs (MCIDs). This is the PDF-spec-compliant approach and provides perfect reading order for Tagged PDFs.

For Untagged PDFs: Falls back to ColumnAware (XY-Cut algorithm).

This mode requires passing MCID reading order through ConversionOptions.mcid_order.

Fields

mcid_order: Vec<u32>

Reading order as a sequence of MCIDs from structure tree traversal. If empty, falls back to ColumnAware mode.

Trait Implementations

impl Clone for ReadingOrderMode

fn clone(&self) -> ReadingOrderMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadingOrderMode

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

Formats the value using the given formatter.

impl PartialEq for ReadingOrderMode

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ReadingOrderMode

impl StructuralPartialEq for ReadingOrderMode