Skip to main content

Module diagnostics

Module diagnostics 

Source
Expand description

Parse-time diagnostics — non-fatal warnings the structural parsers emit when they encounter recoverable malformations.

Every accessor on PdfDocument is fail-soft: it returns valid data on a best-effort basis and skips entries it can’t interpret. When something is skipped, a ParseWarning is recorded so callers can surface a warning to their users (e.g. “this PDF’s outline contained a cycle and was truncated at depth N”) without the absence of the data being silent.

Warnings accumulate on the PdfDocument as accessors are called for the first time; subsequent cached calls don’t re-emit. Use PdfDocument::parse_warnings to inspect.

Structs§

ParseWarning
One non-fatal parsing problem.
WarningSink
Internal accumulator used by parsers to record warnings.

Enums§

LocationHint
Where in the document a problem occurred.
ParsePhase
The structural area a warning came from.
Severity
Severity hint for consumers. The reader treats all of these the same internally; they only inform UI/log presentation.