Enum DocumentError 

#[non_exhaustive]
pub enum DocumentError {
    TesseractNotFound(String),
    TesseractFailed {
        status: i32,
        stderr: String,
    },
    PdfiumNotFound(String),
    PdfRasterFailed(String),
    UnsupportedInput {
        path: PathBuf,
        reason: &'static str,
    },
    Io(Error),
    OutputDir(PathBuf, Error),
    BundleLayoutInvalid {
        reason: BundleLayoutInvalidReason,
    },
    Pipeline(String),
    Serde(Error),
    NotImplemented(&'static str),
}

Crate-level error type for gaze-document.

Fail-closed by construction (Axis 1 reliability): every variant describes a specific, recoverable surface so adopters can branch on cause without matching opaque strings.

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.

TesseractNotFound(String)

Tesseract CLI is not on PATH. The payload is a per-OS install hint.

TesseractFailed

Tesseract returned a non-zero exit status. The payload carries the captured stderr (truncated) so adopters can surface it.

Fields

status: i32

Exit status reported by the OS.

stderr: String

Captured stderr (truncated to keep error payloads bounded).

PdfiumNotFound(String)

pdfium dynamic library could not be loaded. The payload is a per-OS install hint.

PdfRasterFailed(String)

pdfium reported an error while parsing or rasterizing a PDF.

UnsupportedInput

Input file format is not supported by the current build (e.g. PDF input without the pdf-input feature).

Fields

path: PathBuf

Path that was rejected.

reason: &'static str

Reason the input was rejected.

Io(Error)

An I/O error while reading the input or writing the bundle.

OutputDir(PathBuf, Error)

The bundle output directory could not be prepared.

BundleLayoutInvalid

The requested agent/owner bundle directory pair violates the runtime partition contract.

Fields

reason: BundleLayoutInvalidReason

Machine-readable reason for the layout rejection.

Pipeline(String)

gaze::Pipeline construction or invocation failed.

Serde(Error)

serde_json serialization of the bundle report or manifest failed.

NotImplemented(&'static str)

The requested operation is part of the public contract but has no implementation yet. Returned by reserved stubs (Renderer trait, ReadingOrder) until follow-up PRs land.

Trait Implementations

impl Debug for DocumentError

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

Formats the value using the given formatter.

impl Display for DocumentError

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

Formats the value using the given formatter.

impl Error for DocumentError

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

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DocumentError

fn from(err: Error) -> Self

Converts to this type from the input type.