Enum EngineError 

pub enum EngineError {
    InvalidPdf(String),
    PageOutOfRange {
        index: usize,
        count: usize,
    },
    RenderError(String),
    Io(Error),
    Encrypted(String),
    InvalidPageGeometry {
        width: f32,
        height: f32,
        reason: String,
    },
    XfaFlattenFailed(String),
    LimitExceeded(LimitError),
}

Errors that can occur in the rendering engine.

Variants

InvalidPdf(String)

The PDF data is invalid or could not be parsed.

PageOutOfRange

A page index is out of range.

Fields

index: usize

The requested page index.

count: usize

Total number of pages.

RenderError(String)

A rendering error occurred.

Io(Error)

An I/O error occurred.

Encrypted(String)

The PDF is encrypted and requires a password to open.

InvalidPageGeometry

The page has invalid or degenerate dimensions.

Fields

width: f32

Page width in points.

height: f32

Page height in points.

reason: String

Human-readable reason for the failure.

XfaFlattenFailed(String)

XFA flattening failed.

LimitExceeded(LimitError)

A configured resource limit was exceeded during rendering or text extraction. Carries the LimitError so callers can branch on the specific cap that fired.

Implementations

impl EngineError

pub fn ocr_message(&self) -> Option<String>

If this error is an OCR failure carried as EngineError::Io, the failure’s message.

OCR failures ride as I/O errors because this enum is exhaustive in 1.0.0 and a new variant would break semver: engine-construction failures carry the typed pdf_ocr::TesseractCliError, everything else an OcrError, both via [std::io::Error::other]. Callers that need the typed cause downcast std::io::Error::get_ref; callers that only need the message read it here. An OS error, and any other variant, reads as None.

impl EngineError

pub fn options(&self) -> Option<&OptionsError>

The OptionsError carried by this error, if any.

An additive inherent method, so adding it is semver-safe. Callers that used to match EngineError::ConflictingPageSelection check this first, before whatever they do with a plain EngineError::Io.

pub fn model_error(&self) -> Option<&ModelError>

The ModelError carried by this error, if any (#641).

Model failures ride as EngineError::Io because this enum is exhaustive in 1.0.0 and a new variant would break semver; this walks the chain back to the typed cause, on every build. Branch on ModelErrorKind::code.

Trait Implementations

impl Debug for EngineError

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

Formats the value using the given formatter.

impl Display for EngineError

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

Formats the value using the given formatter.

impl Error for EngineError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<EngineError> for VisionError

fn from(source: EngineError) -> Self

Converts to this type from the input type.

impl From<Error> for EngineError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl PdfError for EngineError

fn code(&self) -> &str

Stable machine-readable identifier for the error.

fn help(&self) -> Option<String>

Human-readable, actionable help text.

fn docs_url(&self) -> String

Deep link to the canonical documentation page for this error.