Struct ConversionReport 

pub struct ConversionReport {
    pub pages: usize,
    pub extracted_words: usize,
    pub rendered_words: usize,
    pub extracted_chars: usize,
    pub rendered_chars: usize,
    pub headings_found: usize,
    pub lists_found: usize,
    pub tables_found: usize,
    pub citations_found: usize,
    pub per_page: Vec<PageRecovery>,
}

Audits one PDF-to-Markdown conversion: how much of the extracted text survived into the rendered output, plus a tally of the structural blocks found, so every conversion is auditable rather than a silent best-effort guess.

Fields

pages: usize

extracted_words: usize

split_whitespace().count() word totals, kept for diagnostics only. Do not use these to judge recovery – hyphenation repair, OCR word-gap merges, and table-cell tokenization all legitimately shift word counts by several percent with zero content loss, which made this ratio produce false FAILs on real documents (kopitiam-wwr). ConversionReport::recovery_ratio is the authoritative signal; these fields exist so a human auditing a report still has the raw word counts to look at.

rendered_words: usize

extracted_chars: usize

Non-whitespace character totals underlying the headline recovery_ratio. extracted_chars counts every TextSpan on every page (soft line-wrap hyphens excluded, see is_wrap_hyphen); rendered_chars counts the rendered Markdown after strip_rendered_markdown_syntax removes syntax the renderer added (heading hashes, list markers, table pipes/separators, blockquote markers, code fences, the figure placeholder).

rendered_chars: usize

headings_found: usize

lists_found: usize

tables_found: usize

citations_found: usize

per_page: Vec<PageRecovery>

Per-page character recovery, one entry per source page, in page order. Populated only when the Document carries page provenance (Document::block_pages); empty otherwise (a hand-built document has no page to attribute content to, and guessing would be dishonest). See PageRecovery.

Implementations

impl ConversionReport

pub fn recovery_ratio(&self) -> f64

The authoritative recovery signal: rendered_chars / extracted_chars, both counted as non-whitespace characters after normalizing away renderer-added Markdown syntax and PDF line-wrap hyphenation artifacts (see extracted_content_chars and strip_rendered_markdown_syntax in validation::mod).

What this can detect: content that was extracted from the PDF but never made it into the rendered Markdown – a dropped paragraph, a truncated table, a figure caption that got lost. A character deficit of any size shows up directly as a ratio below 1.0, because unlike a word count, non-whitespace character count cannot be inflated or deflated by re-tokenizing the same content differently.

What this cannot detect: content that survived but was corrupted or reordered – garbled characters from a bad font mapping, two paragraphs swapped, a table’s rows shuffled, a heading demoted to body text. All of those preserve the character count while changing or misplacing the content, so this ratio stays at ~100% and reports PASS regardless. This metric answers “did we lose content?”, not “is the rendered document correct?” – correctness still requires the structural tallies below and, ultimately, human review.

pub fn word_recovery_ratio(&self) -> f64

Secondary, informational-only word-count ratio. See the field docs on extracted_words for why this is not used for PASS/FAIL: it is reported so a human can still see it, not because it is trustworthy on its own.

pub fn passes(&self) -> bool

PASS/FAIL against [MIN_RECOVERY_RATIO], using the character-based recovery_ratio – never the word-count ratio, which is informational only (see kopitiam-wwr).

Trait Implementations

impl Clone for ConversionReport

fn clone(&self) -> ConversionReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConversionReport

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

Formats the value using the given formatter.

impl Default for ConversionReport

fn default() -> ConversionReport

Returns the “default value” for a type.

impl Display for ConversionReport

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

Formats the value using the given formatter.

impl PartialEq for ConversionReport

fn eq(&self, other: &ConversionReport) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ConversionReport