Struct koto_parser::Ast

pub struct Ast { /* fields omitted */ }

A Koto program represented as an Abstract Syntax Tree

This is produced by the parser, and consumed by the compiler.

Implementations

impl Ast

pub fn with_capacity(capacity: usize) -> Self

Initializes an Ast with the given capacity

pub fn push(&mut self, node: Node, span: Span) -> Result<AstIndex, ParserError>

Pushes a node and corresponding span onto the tree

pub fn push_with_span_index(
    &mut self,
    node: Node,
    span_index: AstIndex
) -> Result<AstIndex, ParserError>

Pushes a node onto the tree, associating it with an existing span

pub fn node(&self, index: AstIndex) -> &AstNode

Returns a node for a given node index

pub fn span(&self, index: AstIndex) -> &Span

Returns a span for a given span index

pub fn constants(&self) -> &ConstantPool

Returns the constant pool referred to by the AST

pub fn consume_constants(self) -> ConstantPool

Moves the constants out of the AST

This is used when building a Chunk after compilation. The constants get transferred to the Chunk once the AST has been converted into bytecode.

pub fn entry_point(&self) -> Option<&AstNode>

Returns the root node in the tree

pub fn nodes(&self) -> &[AstNode]

Used in testing to validate the tree’s contents

Trait Implementations

impl Debug for Ast

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

Formats the value using the given formatter.

impl Default for Ast

fn default() -> Ast

Returns the “default value” for a type.