Struct CstRef 

pub struct CstRef<'a, 'src> { /* private fields */ }

A borrowed CST: the source, the arena and the syntax diagnostics.

Implementations

impl<'a, 'src> CstRef<'a, 'src>

pub fn source(&self) -> &'src str

The source.

pub fn root(&self) -> Option<SyntaxNode<'a, 'src>>

The root node (None only for a source over u32::MAX bytes, which is rejected with crate::code::SOURCE_TOO_LONG).

pub fn nodes(&self) -> &'a [Node]

The whole arena, in pre-order.

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

The syntax errors, in source order of detection.

pub fn has_errors(&self) -> bool

Whether any syntax error was reported.

pub fn tokens( &self, ) -> impl Iterator<Item = SyntaxNode<'a, 'src>> + use<'a, 'src>

The tokens (leaves), in source order.

pub fn to_model(&self) -> Parsed<'src>

Lowers the CST to the data model and validates it (spans included); with a syntax error, no model and the syntax diagnostics.

Trait Implementations

impl<'a, 'src> Clone for CstRef<'a, 'src>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, 'src> Copy for CstRef<'a, 'src>

impl<'a, 'src> Debug for CstRef<'a, 'src>

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

Formats the value using the given formatter.

impl Display for CstRef<'_, '_>

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

Writes the tokens’ text in order, which is the source.