Struct SourceFile 

pub struct SourceFile { /* private fields */ }

Parsed Daml module with diagnostics, line index, and lazy token access.

Implementations

impl SourceFile

pub fn parse(source: &str) -> Self

Parses source into a module AST and source-facing presentation data.

Malformed input still returns a partial module and surfaces diagnostics; this function does not fail with Result.

Panics

Panics when a parser diagnostic span does not map to valid UTF-8 source bytes in source.

pub fn source(&self) -> &str

Original source text this file was parsed from.

pub const fn module(&self) -> &Module

Parsed module AST from daml-parser.

pub fn diagnostics(&self) -> &[Diagnostic]

Parse and lexer diagnostics anchored in source text.

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

Line, column, and UTF-16 lookup tables for this source.

pub fn tokens(&self) -> &[Token]

Raw lexer tokens for this source (lazy lex on first access).

pub fn trivia(&self) -> &[Trivia]

Whitespace and comment trivia for this source.

pub fn laid_out_tokens(&self) -> &[Token]

Layout-resolved tokens for this source.

pub fn parser_span_to_text_range(&self, span: ParserSpan) -> TextRange

Convert a parser span from this source into a text-size byte range.

This is the convenience API for spans that originate from this source file and are expected to be valid.

Panics

Panics when span does not map to valid UTF-8 source bytes in this source.

pub fn try_parser_span_to_text_range( &self, span: ParserSpan, ) -> Result<TextRange, ParserSpanToTextRangeError>

Try to convert a parser span from this source into a text-size byte range.

This fallible API is the preferred choice for spans from external or untrusted sources where offsets may be invalid. Use SourceFile::parser_span_to_text_range for spans that originate from this source and are expected to map to valid UTF-8 bytes.

Errors

Returns ParserSpanToTextRangeError when span is out of bounds, inverted, not on a UTF-8 boundary, or cannot fit in TextSize.

Trait Implementations

impl Clone for SourceFile

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceFile

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

Formats the value using the given formatter.

impl Eq for SourceFile

impl PartialEq for SourceFile

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.