docling 1.41.0

DocumentConverter and format backends for docling.rs (a Rust port of docling).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

//! Format backends.
//!
//! A backend parses one source format into a [`DoclingDocument`]. This mirrors
//! docling's `DeclarativeDocumentBackend`: formats whose structure can be read
//! directly, without the page-level ML recognition pipeline.
//!
//! Paginated/ML backends (PDF, images) will get a richer trait in a later phase
//! — see `docs/MIGRATION.md`.

use docling_core::DoclingDocument;

use crate::error::ConversionError;
use crate::source::SourceDocument;

/// Compile a regex once per call site and return a `&'static Regex`. An
/// MSRV-friendly stand-in for `LazyLock` (uses `OnceLock`, stable since 1.70).
/// In textual scope for the backend submodules declared below.
macro_rules! cached_regex {
    ($pat:expr) => {{
        static RE: std::sync::OnceLock<regex::Regex> = std::sync::OnceLock::new();
        RE.get_or_init(|| regex::Regex::new($pat).unwrap())
    }};
}

mod abw;
mod asciidoc;
#[cfg(feature = "web-browser")]
pub(crate) mod browser;
mod cfb;
mod chandra;
mod csv;
mod deepseek;
mod doc;
pub(crate) mod doclang;
mod docling_json;
mod docx;
mod ebcdic;
mod email;
mod epub;
mod html;
pub(crate) mod images;
mod interchange;
mod iwork;
pub(crate) mod jats;
mod latex;
mod lotus;
mod markdown;
mod mhtml;
mod msg;
mod odf;
mod officeart;
mod omml;
mod ooxml;
mod ppt;
mod pptx;
mod quattro;
mod rtf;
mod staroffice5;
pub(crate) mod svg;
pub(crate) mod uspto;
mod uspto_entities;
mod visio;
mod webvtt;
mod wpd;
mod wps;
pub(crate) mod xbrl;
mod xls;
mod xlsx;
mod xlsx_drawings;

pub use abw::AbwBackend;
pub use asciidoc::AsciiDocBackend;
pub use chandra::looks_like_chandra;
#[cfg(feature = "vlm")]
pub(crate) use chandra::parse_chandra_pages as chandra_pages;
pub use csv::CsvBackend;
pub use deepseek::{is_deepseek_markdown, is_unlimited_ocr_markdown, DeepSeekBackend};
#[cfg(feature = "vlm")]
pub(crate) use deepseek::{
    normalize_unlimited_ocr as normalize_unlimited, parse_deepseek_text as deepseek_text,
};
pub use doc::DocBackend;
pub use doclang::DoclangBackend;
pub use docling_json::DoclingJsonBackend;
pub use docx::DocxBackend;
pub use ebcdic::EbcdicBackend;
pub use email::EmailBackend;
pub use epub::EpubBackend;
pub(crate) use html::convert_html;
pub use html::HtmlBackend;
pub(crate) use images::{FsImageResolver, MapImageResolver, NoFetch};
pub use interchange::InterchangeBackend;
pub use iwork::IworkBackend;
pub use jats::JatsBackend;
pub use latex::LatexBackend;
pub use lotus::LotusBackend;
pub use markdown::MarkdownBackend;
pub use mhtml::MhtmlBackend;
pub(crate) use odf::convert_odf;
pub use odf::OdfBackend;
pub use ppt::PptBackend;
pub use pptx::PptxBackend;
pub use quattro::QuattroBackend;
pub use rtf::RtfBackend;
pub use staroffice5::StarOffice5Backend;
pub use svg::SvgBackend;
pub use uspto::UsptoBackend;
pub use visio::VisioBackend;
pub use webvtt::WebVttBackend;
pub use wpd::WpdBackend;
pub use wps::WpsBackend;
pub use xbrl::XbrlBackend;
pub use xls::XlsBackend;
pub use xlsx::XlsxBackend;

/// A backend that converts a source straight into a [`DoclingDocument`].
pub trait DeclarativeBackend {
    /// Parse `source` into a document.
    fn convert(&self, source: &SourceDocument) -> Result<DoclingDocument, ConversionError>;
}

/// Optional headless-browser HTML pre-render, shared by every HTML-routing path
/// (the direct HTML backend via the converter, plus MHTML/EPUB, which assemble
/// HTML from their archives). Returns `html` unchanged unless `use_web_browser`
/// is set, in which case the browser strips computed-hidden elements — requiring
/// the `web-browser` feature, else a clear error rather than a silent no-op.
pub(crate) fn maybe_prerender_html(
    html: &str,
    use_web_browser: bool,
) -> Result<std::borrow::Cow<'_, str>, ConversionError> {
    if !use_web_browser {
        return Ok(std::borrow::Cow::Borrowed(html));
    }
    #[cfg(feature = "web-browser")]
    {
        browser::render_visible_html(html)
            .map(std::borrow::Cow::Owned)
            .map_err(ConversionError::Browser)
    }
    #[cfg(not(feature = "web-browser"))]
    {
        Err(ConversionError::Browser(
            "this build has no web-browser support; rebuild with `--features web-browser`".into(),
        ))
    }
}