Enum ReadingOrder 

pub enum ReadingOrder {
    Content,
    StructureTree,
    Geometric,
}

The order a page’s text is read in. Every extraction entry point takes one; ReadingOrder::Content is the default.

Variants

Content

The content stream’s order: what the producer wrote, which in a typeset document is the order it meant, each column whole before the next. Layout corrects the streams that write across two columns row by row and takes over on a page not written in any order.

StructureTree

The structure tree’s order (ISO 32000-1 §14.7) on a tagged page: the reading order the author declared, /MarkInfo notwithstanding. A page the tree does not reach reads in content order.

Geometric

Position on the page: lines top to bottom, spans left to right, a page with a clear gutter column by column. Interleaves the columns of a two-column page the gutter search does not find; opt in only.

Implementations

impl ReadingOrder

pub const ALL: [ReadingOrder; 3]

Every order, in the order they are documented.

pub fn as_str(self) -> &'static str

The order’s name, content, structure-tree or geometric: what FromStr accepts and Display prints.

Trait Implementations

impl Clone for ReadingOrder

fn clone(&self) -> ReadingOrder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ReadingOrder

impl Debug for ReadingOrder

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

Formats the value using the given formatter.

impl Default for ReadingOrder

fn default() -> ReadingOrder

Returns the “default value” for a type.

impl Display for ReadingOrder

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

Formats the value using the given formatter.

impl Eq for ReadingOrder

impl FromStr for ReadingOrder

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ReadingOrder>

Parses a string s to return a value of this type.

impl Hash for ReadingOrder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ReadingOrder

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReadingOrder