Struct Program 

pub struct Program {
    pub statements: Vec<SpannedStatement>,
    pub comments: Vec<CommentInfo>,
    pub span: Span,
}

Root AST node representing a complete Carmen program.

A program consists of a sequence of statements and any comments found in the source. Comments are preserved to enable formatting and documentation tools.

Fields

statements: Vec<SpannedStatement>

Top-level statements in the program

comments: Vec<CommentInfo>

All comments found in the source

span: Span

Span covering the entire program

Implementations

impl Program

pub fn leading_comments(&self, span: &Span) -> Vec<&CommentInfo>

Get all comments that appear before the given span

pub fn trailing_comments(&self, span: &Span) -> Vec<&CommentInfo>

Get all comments that appear after the given span on the same line

pub fn between_comments( &self, container_span: &Span, element_index: usize, ) -> Vec<&CommentInfo>

Get comments between elements in a list/tuple/etc

pub fn standalone_comments(&self) -> Vec<&CommentInfo>

Get all standalone comments (not associated with specific code)

pub fn comments_in_range( &self, start_offset: usize, end_offset: usize, ) -> Vec<&CommentInfo>

Get all comments within a given span range

pub fn has_comments_between(&self, span1: &Span, span2: &Span) -> bool

Check if there are any comments between two spans

Trait Implementations

impl Clone for Program

fn clone(&self) -> Program

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Program

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

Formats the value using the given formatter.

impl PartialEq for Program

fn eq(&self, other: &Program) -> 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.

impl StructuralPartialEq for Program