Struct SourceDocument 

pub struct SourceDocument {
    pub name: String,
    pub format: InputFormat,
    pub bytes: Vec<u8>,
    pub path: Option<PathBuf>,
    pub base_url: Option<String>,
}

A loaded input document: its name, detected format, and raw bytes.

Fields

name: String

format: InputFormat

bytes: Vec<u8>

path: Option<PathBuf>

The filesystem path it was loaded from, if any (from_file). Used to resolve relative <img src> paths when image fetching is enabled; None for in-memory sources.

base_url: Option<String>

The URL this document was fetched from, if any. Used to resolve relative / protocol-relative <img src> against the page’s origin when image fetching is enabled (an HTML page fetched from the web references its images by relative path). None for local / in-memory sources.

Implementations

impl SourceDocument

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, ConversionError>

Load a document from a filesystem path, detecting the format from the extension.

pub fn from_bytes( name: impl Into<String>, format: InputFormat, bytes: Vec<u8>, ) -> Self

Construct directly from in-memory bytes (no disk access).

pub fn with_base_url(self, url: impl Into<String>) -> Self

Record the URL this document was fetched from (for resolving relative <img src> against the page origin when image fetching is enabled).

pub fn base_dir(&self) -> Option<&Path>

The directory containing the source file, for resolving relative asset paths. None for in-memory sources.

pub fn text(&self) -> Result<&str, ConversionError>

View the bytes as UTF-8 text, for text-based backends. A leading UTF-8 BOM is dropped (docling#4098/#4109, 2.123.1–2.124): Excel and Google Sheets write one when exporting “CSV UTF-8”, and kept it prefixes the first cell/line — # Title/= Title stops being a heading, WebVTT’s signature check misses WEBVTT, JSON parsing rejects the document outright. One strip here covers every text backend.

Trait Implementations

impl Clone for SourceDocument

fn clone(&self) -> SourceDocument

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SourceDocument

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

Formats the value using the given formatter.