Struct ReadingOrder

Source

#[non_exhaustive]
pub struct ReadingOrder { /* private fields */ }

Expand description

Reading-order handle for a single document.

Pre-0.1 placeholder — single-page bundles flow through crate::clean without consulting this type. Multi-page output will route through ReadingOrder::infer in a follow-up PR.

Implementations§

Source §

impl ReadingOrder

Source

pub fn new() -> Result<Self, DocumentError>

Build a reading-order handle.

§Errors

Always returns DocumentError::NotImplemented until the multi-page PR lands. Single-page bundles never call this; the placeholder fails loudly so adopters cannot stumble into silent empty-order output (Axis 1 fail-closed).

Source

pub fn infer(_pages: &[&[u8]]) -> Result<Self, DocumentError>

Infer reading order from raw page payloads.

§Errors

Returns DocumentError::NotImplemented until the multi-page PR lands. Single-page bundles do not need this path.

Auto Trait Implementations§

§

impl UnwindSafe for ReadingOrder

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §