Enum Error 

#[non_exhaustive]
pub enum Error {
    Load(LoadError),
    AlreadyLoaded {
        loaded_from: Option<PathBuf>,
        requested: PathBuf,
    },
    Io(Error),
    PasswordRequired,
    IncorrectPassword,
    UnsupportedSecurity,
    InvalidPdf,
    Pdfium {
        code: u64,
    },
    PageIndexOutOfBounds {
        index: usize,
        count: usize,
    },
    PageLoadFailed {
        index: usize,
    },
    TextLoadFailed {
        index: usize,
    },
    TextTooLarge {
        chars: usize,
        limit: usize,
    },
    FormInitFailed,
    RenderTooLarge {
        required_bytes: u64,
        limit: u64,
    },
    RenderFailed {
        reason: &'static str,
    },
    InvalidConfig(String),
}

All errors returned by the safe API.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Load(LoadError)

The PDFium library could not be loaded.

AlreadyLoaded

PDFium is already loaded from a different library path; the process keeps the first successfully loaded library for its lifetime.

Fields

loaded_from: Option<PathBuf>

Where the active instance was loaded from (None when it was resolved by bare name through the system loader).

requested: PathBuf

The conflicting path passed to this call.

Io(Error)

I/O failure while reading a PDF file from disk.

PasswordRequired

The document is encrypted and requires a password, but none was supplied.

IncorrectPassword

A password was supplied but does not unlock the document.

UnsupportedSecurity

The document uses a security/encryption scheme PDFium does not support.

InvalidPdf

The data is not a PDF, or is too corrupt to open.

Pdfium

PDFium reported an error code this crate does not recognize.

Fields

code: u64

Raw FPDF_GetLastError value.

PageIndexOutOfBounds

Requested page index does not exist.

Fields

index: usize

The requested 0-based page index.

count: usize

The document’s page count.

PageLoadFailed

PDFium failed to load a page that should exist (severely corrupt page tree or content).

Fields

index: usize

The 0-based page index that failed to load.

TextLoadFailed

PDFium failed to prepare the page for text extraction.

Fields

index: usize

The 0-based page index whose text failed to load.

TextTooLarge

The page reports more text characters than the configured extraction limit (see PdfPage::text_with_limit); nothing was allocated.

Fields

chars: usize

Characters PDFium reports on the page.

limit: usize

The configured ceiling.

FormInitFailed

PDFium failed to initialize the form-fill environment.

RenderTooLarge

The rendered output would exceed RenderConfig::max_output_bytes (or the hard i32 pixel-dimension limits of PDFium’s bitmap API).

Fields

required_bytes: u64

Bytes the requested output would need.

limit: u64

The configured ceiling.

RenderFailed

Rendering failed inside PDFium (bitmap creation or coordinate transform rejected).

Fields

reason: &'static str

Which PDFium operation rejected the render.

InvalidConfig(String)

An argument or configuration value is invalid (zero/non-finite scale, zero target dimensions, interior NUL byte in a password, …).

Implementations

impl Error

pub fn is_encryption_error(&self) -> bool

True when the failure is specifically about encryption/passwords: Error::PasswordRequired, Error::IncorrectPassword, or Error::UnsupportedSecurity.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<LoadError> for Error

fn from(e: LoadError) -> Self

Converts to this type from the input type.