Struct ParseResult 

pub struct ParseResult { /* private fields */ }

Owns a parsed document, its backing text, and non-fatal warnings.

A successful parse can contain recovered content. Check Self::source_recovery when the application requires complete input, and Self::warnings for all diagnostics.

Implementations

impl ParseResult

pub fn document(&self) -> &Document<'_>

Borrow the document AST.

pub fn source(&self) -> &str

Borrow the preprocessed source the AST was parsed from.

Note: this is the text as seen by the grammar, after include resolution and other preprocessor transforms — not the original caller input.

pub fn source_location(&self, location: &Location) -> SourceLocation

Resolve a location from this result’s AST to its original source file and position.

Includes use the file resolved during preprocessing, even when selection or indentation changed the parsed text. A span crossing files is anchored in the file containing its start. Unknown include chains have no file.

pub fn warnings(&self) -> &[Warning]

Borrow the collected warnings.

pub fn source_recovery(&self) -> Option<&Warning>

The first warning for recovered source content or structure, when present.

This includes omitted content, ignored substitutions, and unmatched block boundaries, but excludes presentation warnings. It remains available after Self::take_warnings.

pub fn take_warnings(&mut self) -> Vec<Warning>

Take the warnings, leaving Self::warnings empty.

The document and Self::source_recovery remain available.

Trait Implementations

impl Debug for ParseResult

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

Formats the value using the given formatter.