Struct SyntaxDocument 

pub struct SyntaxDocument { /* private fields */ }

A loss-aware YAML document and its original source text.

The underlying concrete syntax tree is intentionally private so ComposeLens can maintain a stable API independently of its parser dependency. Rendering this initial representation emits the concrete syntax tree without normalization, interpolation, or environment access.

Implementations

impl SyntaxDocument

pub fn parse( source_id: SourceId, source: impl Into<Arc<str>>, ) -> Result<SyntaxParse, SyntaxParseError>

Parses YAML into a loss-aware document and structured diagnostics.

Recoverable YAML errors are returned in SyntaxParse::diagnostics while the syntax document remains available. Only sources too large for the concrete syntax tree produce a fatal error.

Errors

Returns SyntaxParseError when the source exceeds the concrete syntax tree’s byte-offset capacity. Malformed YAML is recoverable and is reported through structured diagnostics.

pub const fn source_id(&self) -> SourceId

Returns the source identifier supplied by the caller.

pub fn source_text(&self) -> &str

Returns the original source text.

pub fn source_span(&self) -> SourceSpan

Returns the span covering the complete source text.

pub fn text(&self, span: SourceSpan) -> Option<&str>

Returns the source text covered by a span from this document.

pub fn line_column(&self, byte_offset: usize) -> Option<LineColumn>

Converts a byte offset in this document to a one-based line and column.

pub fn document_count(&self) -> usize

Returns the number of YAML documents in the stream.

pub fn comment_count(&self) -> usize

Returns the number of comment tokens retained by the concrete syntax tree.

pub fn render_preserved(&self) -> String

Renders the concrete syntax tree without semantic changes.

Trait Implementations

impl Clone for SyntaxDocument

fn clone(&self) -> SyntaxDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxDocument

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

Formats the value using the given formatter.

impl Eq for SyntaxDocument

impl PartialEq for SyntaxDocument

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SyntaxDocument