Struct full_moon::ast::Ast

pub struct Ast<'a> { /* fields omitted */ }

An abstract syntax tree, contains all the nodes used in the code

Implementations

impl Ast<'_>

pub fn update_positions(self) -> Self

Will update the positions of all the tokens in the tree Necessary if you are both mutating the tree and need the positions of the tokens

impl<'a> Ast<'a>

pub fn from_tokens(tokens: Vec<Token<'a>>) -> Result<Ast<'a>, AstError<'a>>

Create an Ast from the passed tokens. You probably want parse

Errors

If the tokens passed are impossible to get through normal tokenization, an error of Empty (if the vector is empty) or NoEof (if there is no eof token) will be returned.

More likely, if the tokens pass are invalid Lua 5.1 code, an UnexpectedToken error will be returned.

pub fn with_nodes(self, nodes: Block<'a>) -> Self

Returns a new Ast with the given nodes

pub fn with_eof(self, eof: TokenReference<'a>) -> Self

Returns a new Ast with the given EOF token

pub fn nodes(&self) -> &Block<'a>

The entire code of the function

assert_eq!(full_moon::parse("local x = 1; local y = 2")?.nodes().stmts().count(), 2);

pub fn nodes_mut(&mut self) -> &mut Block<'a>

The entire code of the function, but mutable

pub fn eof(&self) -> &TokenReference<'a>

The EOF token at the end of every Ast

Trait Implementations

impl<'a> Clone for Ast<'a>

fn clone(&self) -> Ast<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Ast<'a>

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

Formats the value using the given formatter.

impl<'a> Node<'a> for Ast<'a>

fn start_position(&self) -> Option<Position>

The start position of a node. None if can’t be determined

fn end_position(&self) -> Option<Position>

The end position of a node. None if it can’t be determined

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

Whether another node of the same type is the same as this one semantically, ignoring position

fn tokens<'b>(&'b self) -> Tokens<'a, 'b>

The token references that comprise a node

fn range(&self) -> Option<(Position, Position)>

The full range of a node, if it has both start and end positions

fn surrounding_trivia<'b>(
    &'b self
) -> (Vec<&'b Token<'ast>>, Vec<&'b Token<'ast>>)

The tokens surrounding a node that are ignored and not accessible through the node’s own accessors. Use this if you want to get surrounding comments or whitespace. Returns a tuple of the leading and trailing trivia.

impl<'a> Owned for Ast<'a>

type Owned = Ast<'static>

What an owned version of the object looks like. Usually contains a 'static lifetime.

fn owned(&self) -> Self::Owned

Returns an owned version of the object.