Enum ConversionError 

pub enum ConversionError {
    Io(Error),
    UnknownFormat {
        hint: String,
    },
    UnsupportedFormat(InputFormat),
    Parse(String),
    Streaming(String),
    Browser(String),
    WithSource {
        context: String,
        source: Box<dyn Error + Send + Sync>,
    },
}

Anything that can go wrong while loading or converting a source document.

Variants

Io(Error)

Reading the input from disk failed.

UnknownFormat

The file extension (or content) did not map to a known format.

Fields

hint: String

UnsupportedFormat(InputFormat)

The format is known but no backend is wired up for it yet.

Parse(String)

The backend recognized the format but failed to parse the content.

Streaming(String)

The requested streaming conversion is not supported (e.g. JSON, or the referenced image mode, which both need the whole document up front).

Browser(String)

The headless-browser pre-render (--use-web-browser) failed, or the crate was built without the web-browser feature.

WithSource

A dependency failed during conversion. Unlike ConversionError::Parse the underlying error is kept alive (not flattened into a string), so callers can walk std::error::Error::source and downcast to the original type — e.g. to tell a truncated archive from malformed XML.

Fields

context: String

What was being converted when the failure happened (backend prefix, mirroring the Parse message style: “xlsx”, “docling-json”, …).

source: Box<dyn Error + Send + Sync>

The error that caused the failure, preserved on the chain.

Implementations

impl ConversionError

pub fn with_source( context: impl Into<String>, source: impl Into<Box<dyn Error + Send + Sync>>, ) -> Self

Wrap a dependency error, keeping it reachable via std::error::Error::source instead of stringifying it.

Trait Implementations

impl Debug for ConversionError

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

Formats the value using the given formatter.

impl Display for ConversionError

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

Formats the value using the given formatter.

impl Error for ConversionError

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 ConversionError

fn from(e: Error) -> Self

Converts to this type from the input type.