Struct ParsedDoc 

pub struct ParsedDoc { /* private fields */ }

A successfully parsed document: source buffer, line index, and syntax root.

Use this as the single entry point for:

• Compiler: root() to walk the tree, offset_to_line_col() and format_diagnostic() for errors, source() for span slices.
• Formatter: root() for token_groups() and trivia, source() or token/node text for rewriting.

Implementations

impl ParsedDoc

pub fn new(source: Vec<u8>, output: &ParseOutput) -> Option<ParsedDoc>

Build a parsed document from the raw source and parse output.

Returns None if the output has no or invalid tree events (e.g. empty or malformed). The source slice used during parsing should match what you pass here so that token text and spans are correct.

pub fn from_slice(source: &[u8], output: &ParseOutput) -> Option<ParsedDoc>

Build a parsed document from a source slice and parse output.

Clones source into a Vec<u8>. Prefer new when you already own a Vec<u8>. Returns None if the output has no or invalid tree events.

pub const fn root(&self) -> &SyntaxNode

Reference to the syntax tree root.

pub fn source(&self) -> &[u8]

Raw source bytes.

pub fn source_str(&self) -> &str

Source as UTF-8 str, or empty if invalid UTF-8.

pub const fn line_index(&self) -> &LineIndex

Line index for this document (offset → line/column, snippets).

pub fn offset_to_line_col(&self, offset: u32) -> (u32, u32)

Line and column (0-based) for a byte offset.

pub fn offset_to_line_col_1based(&self, offset: u32) -> (u32, u32)

Line and column (1-based) for error messages and IDE.

pub fn snippet_at(&self, offset: u32) -> String

Single-line snippet with caret at the given offset (for ad-hoc errors).

pub fn format_diagnostic( &self, diagnostic: &Diagnostic, literals: Option<&LiteralTable>, rule_names: Option<&[&'static str]>, expected_labels: Option<&[&'static str]>, ) -> String

Format a parse diagnostic with line/column and source snippet.

Pass the grammar’s literal, rule-name, and expected-label tables for readable “expected” strings; otherwise literal/rule/label ids are shown.

pub fn span_slice(&self, span: Span) -> &[u8]

Byte slice for a span (convenience for compiler/formatter).

pub fn format_semantic_diagnostic( &self, diagnostic: &SemanticDiagnostic, ) -> String

Format a semantic (analysis) diagnostic with line/column and source snippet.

Use this to report validation/analysis errors and warnings in the same style as parse errors. For miette reports, use SemanticDiagnostic::into_miette with self.source_str() and your file name.

pub fn node_at_offset(&self, offset: u32) -> Option<SyntaxNode>

Return the smallest syntax node whose range contains the given byte offset.

pub fn token_at_offset(&self, offset: u32) -> Option<SyntaxToken>

Return the deepest token at the given byte offset (including trivia).

Trait Implementations

impl Debug for ParsedDoc

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

Formats the value using the given formatter.